Skip to content

Commit

Permalink
Use top-level await in jsdoc examples (#3239)
Browse files Browse the repository at this point in the history
  • Loading branch information
hayd authored and ry committed Oct 29, 2019
1 parent 14713ad commit 3c2399e
Showing 1 changed file with 11 additions and 19 deletions.
30 changes: 11 additions & 19 deletions cli/js/files.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,7 @@ export function openSync(filename: string, mode: OpenMode = "r"): File {

/** Open a file and return an instance of the `File` object.
*
* (async () => {
* const file = await Deno.open("/foo/bar.txt");
* })();
* const file = await Deno.open("/foo/bar.txt");
*/
export async function open(
filename: string,
Expand Down Expand Up @@ -66,12 +64,10 @@ export function readSync(rid: number, p: Uint8Array): number | EOF {
*
* Resolves with the `number | EOF` for the operation.
*
* (async () => {
* const file = await Deno.open("/foo/bar.txt");
* const buf = new Uint8Array(100);
* const nread = await Deno.read(file.rid, buf);
* const text = new TextDecoder().decode(buf);
* })();
* const file = await Deno.open("/foo/bar.txt");
* const buf = new Uint8Array(100);
* const nread = await Deno.read(file.rid, buf);
* const text = new TextDecoder().decode(buf);
*/
export async function read(rid: number, p: Uint8Array): Promise<number | EOF> {
const nread = await sendAsyncMinimal(dispatch.OP_READ, rid, p);
Expand Down Expand Up @@ -106,12 +102,10 @@ export function writeSync(rid: number, p: Uint8Array): number {
*
* Resolves with the number of bytes written.
*
* (async () => {
* const encoder = new TextEncoder();
* const data = encoder.encode("Hello world\n");
* const file = await Deno.open("/foo/bar.txt");
* await Deno.write(file.rid, data);
* })();
* const encoder = new TextEncoder();
* const data = encoder.encode("Hello world\n");
* const file = await Deno.open("/foo/bar.txt");
* await Deno.write(file.rid, data);
*
*/
export async function write(rid: number, p: Uint8Array): Promise<number> {
Expand All @@ -134,10 +128,8 @@ export function seekSync(rid: number, offset: number, whence: SeekMode): void {

/** Seek a file ID to the given offset under mode given by `whence`.
*
* (async () => {
* const file = await Deno.open("/foo/bar.txt");
* await Deno.seek(file.rid, 0, 0);
* })();
* const file = await Deno.open("/foo/bar.txt");
* await Deno.seek(file.rid, 0, 0);
*/
export async function seek(
rid: number,
Expand Down

0 comments on commit 3c2399e

Please sign in to comment.