diff options
author | nasa <htilcs1115@gmail.com> | 2023-06-02 23:28:05 +0900 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-06-02 08:28:05 -0600 |
commit | 25fdc7bf6c72967cec2bfbd3f18246d1515fce57 (patch) | |
tree | 9c16622c79c6ff8c325e29c9b76edab596a7b550 /ext/node/polyfills/internal/fs | |
parent | 98461e2559a823c5042346db7edf811985c4e9a5 (diff) |
feat(node_compat): Added base implementation of FileHandle (#19294)
<!--
Before submitting a PR, please read https://deno.com/manual/contributing
1. Give the PR a descriptive title.
Examples of good title:
- fix(std/http): Fix race condition in server
- docs(console): Update docstrings
- feat(doc): Handle nested reexports
Examples of bad title:
- fix #7123
- update docs
- fix bugs
2. Ensure there is a related issue and it is referenced in the PR text.
3. Ensure there are tests that cover the changes.
4. Ensure `cargo test` passes.
5. Ensure `./tools/format.js` passes without changing files.
6. Ensure `./tools/lint.js` passes.
7. Open as a draft PR if your work is still in progress. The CI won't
run
all steps, but you can add '[ci]' to a commit message to force it to.
8. If you would like to run the benchmarks on the CI, add the 'ci-bench'
label.
-->
## WHY
ref: https://github.com/denoland/deno/issues/19165
Node's fs/promises includes a FileHandle class, but deno does not. The
open function in Node's fs/promises returns a FileHandle, which provides
an IO interface to the file. However, deno's open function returns a
resource id.
### deno
```js
> const fs = await import("node:fs/promises");
undefined
> const file3 = await fs.open("./README.md");
undefined
> file3
3
> file3.read
undefined
Node:
```
### Node
```js
> const fs = await import("fs/promises");
undefined
> const file3 = await fs.open("./tests/e2e_unit/testdata/file.txt");
undefined
> file3
FileHandle {
_events: [Object: null prototype] {},
_eventsCount: 0,
_maxListeners: undefined,
close: [Function: close],
[Symbol(kCapture)]: false,
[Symbol(kHandle)]: FileHandle {},
[Symbol(kFd)]: 24,
[Symbol(kRefs)]: 1,
[Symbol(kClosePromise)]: null
}
> file3.read
[Function: read]
```
To be compatible with Node, deno's open function should also return a
FileHandle.
## WHAT
I have implemented the first step in adding a FileHandle.
- Changed the return value of the open function to a FileHandle object
- Implemented the readFile method in FileHandle
- Add test code
## What to do next
This PR is the first step in adding a FileHandle, and there are things
that should be done next.
- Add functionality equivalent to Node's FileHandle to FileHandle
(currently there is only readFile)
---------
Co-authored-by: Matt Mastracci <matthew@mastracci.com>
Diffstat (limited to 'ext/node/polyfills/internal/fs')
-rw-r--r-- | ext/node/polyfills/internal/fs/handle.ts | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/ext/node/polyfills/internal/fs/handle.ts b/ext/node/polyfills/internal/fs/handle.ts new file mode 100644 index 000000000..a369a4a4d --- /dev/null +++ b/ext/node/polyfills/internal/fs/handle.ts @@ -0,0 +1,31 @@ +// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license. +import { EventEmitter } from "ext:deno_node/events.ts"; +import { Buffer } from "ext:deno_node/buffer.ts"; +import { promises } from "ext:deno_node/fs.ts"; +import { + BinaryOptionsArgument, + FileOptionsArgument, + TextOptionsArgument, +} from "ext:deno_node/_fs/_fs_common.ts"; + +export class FileHandle extends EventEmitter { + #rid: number; + constructor(rid: number) { + super(); + this.rid = rid; + } + + get fd() { + return this.rid; + } + + readFile( + opt?: TextOptionsArgument | BinaryOptionsArgument | FileOptionsArgument, + ): Promise<string | Buffer> { + return promises.readFile(this, opt); + } +} + +export default { + FileHandle, +}; |