summaryrefslogtreecommitdiff
path: root/cli/tsc
diff options
context:
space:
mode:
authorBartek IwaƄczuk <biwanczuk@gmail.com>2023-05-04 14:37:45 +0200
committerGitHub <noreply@github.com>2023-05-04 14:37:45 +0200
commit8382adaf7dcc9c813a51552cca196121c02a650e (patch)
tree46f8e40b283bb34eb8405617e90e671574b2f0dc /cli/tsc
parent95e209a0e4ef0e4a0b886583057b84ef204261d3 (diff)
docs: update Deno.Writer docstring (#18987)
Closes https://github.com/denoland/deno/issues/18985#issuecomment-1534493623
Diffstat (limited to 'cli/tsc')
-rw-r--r--cli/tsc/dts/lib.deno.ns.d.ts6
1 files changed, 6 insertions, 0 deletions
diff --git a/cli/tsc/dts/lib.deno.ns.d.ts b/cli/tsc/dts/lib.deno.ns.d.ts
index 4b8dbb7fd..395f8c667 100644
--- a/cli/tsc/dts/lib.deno.ns.d.ts
+++ b/cli/tsc/dts/lib.deno.ns.d.ts
@@ -1488,6 +1488,12 @@ declare namespace Deno {
* would resolve to `n` < `p.byteLength`. `write()` must not modify the
* slice data, even temporarily.
*
+ * 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.
+ *
* Implementations should not retain a reference to `p`.
*/
write(p: Uint8Array): Promise<number>;