summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAsher Gomez <ashersaupingomez@gmail.com>2023-10-05 19:44:37 +1100
committerGitHub <noreply@github.com>2023-10-05 10:44:37 +0200
commitfd4fc2d81830c8350ccdc7be689db31183ada235 (patch)
treeb3f2f60971dc9a8bfb8791f67605116ae4163406
parent1ff525e25b6ca833893c03f720a1298adffb37db (diff)
docs: update alternative APIs for `write()`, `writeSync()`, `read()` and `readSync()` (#20792)
Closes #20701
-rw-r--r--cli/tsc/dts/lib.deno.ns.d.ts25
1 files changed, 9 insertions, 16 deletions
diff --git a/cli/tsc/dts/lib.deno.ns.d.ts b/cli/tsc/dts/lib.deno.ns.d.ts
index 2386cf10f..6784ee052 100644
--- a/cli/tsc/dts/lib.deno.ns.d.ts
+++ b/cli/tsc/dts/lib.deno.ns.d.ts
@@ -1877,9 +1877,8 @@ declare namespace Deno {
* not indicate EOF.
*
* This function is one of the lowest level APIs and most users should not
- * work with this directly, but rather use
- * [`readAll()`](https://deno.land/std/streams/read_all.ts?s=readAll) from
- * [`std/streams/read_all.ts`](https://deno.land/std/streams/read_all.ts)
+ * work with this directly, but rather use {@linkcode ReadableStream} and
+ * {@linkcode https://deno.land/std/streams/mod.ts?s=toArrayBuffer|toArrayBuffer}
* instead.
*
* **It is not guaranteed that the full buffer will be read in a single call.**
@@ -1907,10 +1906,8 @@ declare namespace Deno {
* not indicate EOF.
*
* This function is one of the lowest level APIs and most users should not
- * work with this directly, but rather use
- * [`readAllSync()`](https://deno.land/std/streams/read_all.ts?s=readAllSync)
- * from
- * [`std/streams/read_all.ts`](https://deno.land/std/streams/read_all.ts)
+ * work with this directly, but rather use {@linkcode ReadableStream} and
+ * {@linkcode https://deno.land/std/streams/mod.ts?s=toArrayBuffer|toArrayBuffer}
* instead.
*
* **It is not guaranteed that the full buffer will be read in a single
@@ -1932,10 +1929,9 @@ declare namespace Deno {
/** Write to the resource ID (`rid`) the contents of the array buffer (`data`).
*
* Resolves to the number of bytes written. This function is one of the lowest
- * level APIs and most users should not work with this directly, but rather use
- * [`writeAll()`](https://deno.land/std/streams/write_all.ts?s=writeAll) from
- * [`std/streams/write_all.ts`](https://deno.land/std/streams/write_all.ts)
- * instead.
+ * level APIs and most users should not work with this directly, but rather
+ * use {@linkcode WritableStream}, {@linkcode ReadableStream.from} and
+ * {@linkcode ReadableStream.pipeTo}.
*
* **It is not guaranteed that the full buffer will be written in a single
* call.**
@@ -1957,11 +1953,8 @@ declare namespace Deno {
*
* Returns the number of bytes written. This function is one of the lowest
* level APIs and most users should not work with this directly, but rather
- * use
- * [`writeAllSync()`](https://deno.land/std/streams/write_all.ts?s=writeAllSync)
- * from
- * [`std/streams/write_all.ts`](https://deno.land/std/streams/write_all.ts)
- * instead.
+ * use {@linkcode WritableStream}, {@linkcode ReadableStream.from} and
+ * {@linkcode ReadableStream.pipeTo}.
*
* **It is not guaranteed that the full buffer will be written in a single
* call.**