summaryrefslogtreecommitdiff
path: root/ext
diff options
context:
space:
mode:
authorAsher Gomez <ashersaupingomez@gmail.com>2024-01-24 23:36:35 +1100
committerGitHub <noreply@github.com>2024-01-24 13:36:35 +0100
commitaac0ad32bd589394316223f75e6f511331ff124c (patch)
tree695507e2303a3edc9920c4be2bbf06055581f8d2 /ext
parentc98ab51746776397502df089706c8bb6946882ff (diff)
feat: deprecate `Deno.FsFile` constructor and `Deno.FsFile.rid` (#22072)
Diffstat (limited to 'ext')
-rw-r--r--ext/fs/30_fs.js41
-rw-r--r--ext/node/polyfills/_fs/_fs_readFile.ts3
-rw-r--r--ext/node/polyfills/_fs/_fs_writeFile.ts5
3 files changed, 28 insertions, 21 deletions
diff --git a/ext/fs/30_fs.js b/ext/fs/30_fs.js
index d0f7a2fad..810089950 100644
--- a/ext/fs/30_fs.js
+++ b/ext/fs/30_fs.js
@@ -670,85 +670,90 @@ class FsFile {
}
get rid() {
+ internals.warnOnDeprecatedApi(
+ "Deno.FsFile.rid",
+ new Error().stack,
+ "Use `Deno.FsFile` methods directly instead.",
+ );
return this.#rid;
}
write(p) {
- return write(this.rid, p);
+ return write(this.#rid, p);
}
writeSync(p) {
- return writeSync(this.rid, p);
+ return writeSync(this.#rid, p);
}
truncate(len) {
- return ftruncate(this.rid, len);
+ return ftruncate(this.#rid, len);
}
truncateSync(len) {
- return ftruncateSync(this.rid, len);
+ return ftruncateSync(this.#rid, len);
}
read(p) {
- return read(this.rid, p);
+ return read(this.#rid, p);
}
readSync(p) {
- return readSync(this.rid, p);
+ return readSync(this.#rid, p);
}
seek(offset, whence) {
- return seek(this.rid, offset, whence);
+ return seek(this.#rid, offset, whence);
}
seekSync(offset, whence) {
- return seekSync(this.rid, offset, whence);
+ return seekSync(this.#rid, offset, whence);
}
stat() {
- return fstat(this.rid);
+ return fstat(this.#rid);
}
statSync() {
- return fstatSync(this.rid);
+ return fstatSync(this.#rid);
}
async dataSync() {
- await op_fs_fdatasync_async(this.rid);
+ await op_fs_fdatasync_async(this.#rid);
}
dataSyncSync() {
- op_fs_fdatasync_sync(this.rid);
+ op_fs_fdatasync_sync(this.#rid);
}
close() {
- core.close(this.rid);
+ core.close(this.#rid);
}
get readable() {
if (this.#readable === undefined) {
- this.#readable = readableStreamForRid(this.rid);
+ this.#readable = readableStreamForRid(this.#rid);
}
return this.#readable;
}
get writable() {
if (this.#writable === undefined) {
- this.#writable = writableStreamForRid(this.rid);
+ this.#writable = writableStreamForRid(this.#rid);
}
return this.#writable;
}
async sync() {
- await op_fs_fsync_async(this.rid);
+ await op_fs_fsync_async(this.#rid);
}
syncSync() {
- op_fs_fsync_sync(this.rid);
+ op_fs_fsync_sync(this.#rid);
}
[SymbolDispose]() {
- core.tryClose(this.rid);
+ core.tryClose(this.#rid);
}
}
diff --git a/ext/node/polyfills/_fs/_fs_readFile.ts b/ext/node/polyfills/_fs/_fs_readFile.ts
index 7e231d8ec..de1a2a30d 100644
--- a/ext/node/polyfills/_fs/_fs_readFile.ts
+++ b/ext/node/polyfills/_fs/_fs_readFile.ts
@@ -18,6 +18,7 @@ import {
Encodings,
TextEncodings,
} from "ext:deno_node/_utils.ts";
+import { FsFile } from "ext:deno_fs/30_fs.js";
function maybeDecode(data: Uint8Array, encoding: TextEncodings): string;
function maybeDecode(
@@ -72,7 +73,7 @@ export function readFile(
let p: Promise<Uint8Array>;
if (path instanceof FileHandle) {
- const fsFile = new Deno.FsFile(path.fd);
+ const fsFile = new FsFile(path.fd);
p = readAll(fsFile);
} else {
p = Deno.readFile(path);
diff --git a/ext/node/polyfills/_fs/_fs_writeFile.ts b/ext/node/polyfills/_fs/_fs_writeFile.ts
index 47d5d38b4..40d368566 100644
--- a/ext/node/polyfills/_fs/_fs_writeFile.ts
+++ b/ext/node/polyfills/_fs/_fs_writeFile.ts
@@ -24,6 +24,7 @@ import {
validateStringAfterArrayBufferView,
} from "ext:deno_node/internal/fs/utils.mjs";
import { promisify } from "ext:deno_node/internal/util.mjs";
+import { FsFile } from "ext:deno_fs/30_fs.js";
interface Writer {
write(p: Uint8Array): Promise<number>;
@@ -73,7 +74,7 @@ export function writeFile(
(async () => {
try {
file = isRid
- ? new Deno.FsFile(pathOrRid as number)
+ ? new FsFile(pathOrRid as number)
: await Deno.open(pathOrRid as string, openOptions);
// ignore mode because it's not supported on windows
@@ -138,7 +139,7 @@ export function writeFileSync(
let error: Error | null = null;
try {
file = isRid
- ? new Deno.FsFile(pathOrRid as number)
+ ? new FsFile(pathOrRid as number)
: Deno.openSync(pathOrRid as string, openOptions);
// ignore mode because it's not supported on windows