summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAsher Gomez <ashersaupingomez@gmail.com>2024-01-24 15:12:03 +1100
committerGitHub <noreply@github.com>2024-01-24 09:42:03 +0530
commitc98ab51746776397502df089706c8bb6946882ff (patch)
tree76dd44497b75f7ff48df7d83ee177176dbec4764
parentea48bee3f7f08459c217ed5456e2ca1875ceb8d3 (diff)
feat: deprecate `Deno.read()` and `Deno.readSync()` (#22063)
For removal in Deno v2.
-rw-r--r--cli/tests/unit_node/tls_test.ts6
-rw-r--r--cli/tsc/dts/lib.deno.ns.d.ts6
-rw-r--r--runtime/js/90_deno_ns.js18
3 files changed, 25 insertions, 5 deletions
diff --git a/cli/tests/unit_node/tls_test.ts b/cli/tests/unit_node/tls_test.ts
index 2124cb412..e7224ff6d 100644
--- a/cli/tests/unit_node/tls_test.ts
+++ b/cli/tests/unit_node/tls_test.ts
@@ -111,20 +111,20 @@ Deno.test("tls.createServer creates a TLS server", async () => {
});
const buf = new Uint8Array(100);
- await Deno.read(conn.rid, buf);
+ await conn.read(buf);
let text: string;
text = new TextDecoder().decode(buf);
assertEquals(text.replaceAll("\0", ""), "welcome!\n");
buf.fill(0);
Deno.write(conn.rid, new TextEncoder().encode("hey\n"));
- await Deno.read(conn.rid, buf);
+ await conn.read(buf);
text = new TextDecoder().decode(buf);
assertEquals(text.replaceAll("\0", ""), "hey\n");
buf.fill(0);
Deno.write(conn.rid, new TextEncoder().encode("goodbye\n"));
- await Deno.read(conn.rid, buf);
+ await conn.read(buf);
text = new TextDecoder().decode(buf);
assertEquals(text.replaceAll("\0", ""), "goodbye\n");
diff --git a/cli/tsc/dts/lib.deno.ns.d.ts b/cli/tsc/dts/lib.deno.ns.d.ts
index cc069ed98..a388a9074 100644
--- a/cli/tsc/dts/lib.deno.ns.d.ts
+++ b/cli/tsc/dts/lib.deno.ns.d.ts
@@ -1984,6 +1984,9 @@ declare namespace Deno {
* Deno.close(file.rid);
* ```
*
+ * @deprecated Use `reader.read()` instead. {@linkcode Deno.read} will be
+ * removed in Deno 2.0.
+ *
* @category I/O
*/
export function read(rid: number, buffer: Uint8Array): Promise<number | null>;
@@ -2014,6 +2017,9 @@ declare namespace Deno {
* Deno.close(file.rid);
* ```
*
+ * @deprecated Use `reader.readSync()` instead. {@linkcode Deno.readSync}
+ * will be removed in Deno 2.0.
+ *
* @category I/O
*/
export function readSync(rid: number, buffer: Uint8Array): number | null;
diff --git a/runtime/js/90_deno_ns.js b/runtime/js/90_deno_ns.js
index 24e73d30e..f93f9f134 100644
--- a/runtime/js/90_deno_ns.js
+++ b/runtime/js/90_deno_ns.js
@@ -96,8 +96,22 @@ const denoNs = {
iter: io.iter,
iterSync: io.iterSync,
SeekMode: io.SeekMode,
- read: io.read,
- readSync: io.readSync,
+ read(rid, buffer) {
+ internals.warnOnDeprecatedApi(
+ "Deno.read()",
+ new Error().stack,
+ "Use `reader.read()` instead.",
+ );
+ return io.read(rid, buffer);
+ },
+ readSync(rid, buffer) {
+ internals.warnOnDeprecatedApi(
+ "Deno.readSync()",
+ new Error().stack,
+ "Use `reader.readSync()` instead.",
+ );
+ return io.readSync(rid, buffer);
+ },
write: io.write,
writeSync: io.writeSync,
File: fs.File,