foster/denoland-deno
1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-12-01 16:51:13 -05:00
Code Issues Packages 1 Wiki Activity

doc: clarify and warn on Deno.read/write behaviour (#5743)

Browse source
This commit is contained in:
Chris Knight 2020-05-22 17:56:12 +01:00 committed by GitHub
parent f9e45114b9
commit 4b06e35765
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
cli/js/lib.deno.ns.d.ts vendored
View file

@ -456,6 +456,11 @@ declare namespace Deno {
* It is possible for a read to successfully return with `0` bytes. This does * It is possible for a read to successfully return with `0` bytes. This does
* not indicate EOF. * not indicate EOF.
* *
* This function is one of the lowest level APIs and most users should not
* work with this directly, but rather use Deno.readAllSync() instead.
*
* **It is not guaranteed that the full buffer will be read in a single call.**
*
* ```ts * ```ts
* // if "/foo/bar.txt" contains the text "hello world": * // if "/foo/bar.txt" contains the text "hello world":
* const file = Deno.openSync("/foo/bar.txt"); * const file = Deno.openSync("/foo/bar.txt");
@ -475,6 +480,11 @@ declare namespace Deno {
* It is possible for a read to successfully return with `0` bytes. This does * It is possible for a read to successfully return with `0` bytes. This does
* not indicate EOF. * not indicate EOF.
* *
* This function is one of the lowest level APIs and most users should not
* work with this directly, but rather use Deno.readAll() instead.
*
* **It is not guaranteed that the full buffer will be read in a single call.**
*
* ```ts * ```ts
* // if "/foo/bar.txt" contains the text "hello world": * // if "/foo/bar.txt" contains the text "hello world":
* const file = await Deno.open("/foo/bar.txt"); * const file = await Deno.open("/foo/bar.txt");
@ -489,7 +499,12 @@ declare namespace Deno {
/** Synchronously write to the resource ID (`rid`) the contents of the array /** Synchronously write to the resource ID (`rid`) the contents of the array
* buffer (`data`). * buffer (`data`).
* *
* Returns the number of bytes written. * 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
* Deno.writeAllSync() instead.
*
* **It is not guaranteed that the full buffer will be written in a single
* call.**
* *
* ```ts * ```ts
* const encoder = new TextEncoder(); * const encoder = new TextEncoder();
@ -503,7 +518,12 @@ declare namespace Deno {
/** Write to the resource ID (`rid`) the contents of the array buffer (`data`). /** Write to the resource ID (`rid`) the contents of the array buffer (`data`).
* *
* Resolves to the number of bytes written. * 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
* Deno.writeAll() instead.
*
* **It is not guaranteed that the full buffer will be written in a single
* call.**
* *
* ```ts * ```ts
* const encoder = new TextEncoder(); * const encoder = new TextEncoder();