1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-11-25 15:29:32 -05:00

fix(#10360): clarify JSDoc for Deno.noColor (#10373)

Fixes #10360 

Co-authored-by: Luca Casonato <lucacasonato@yahoo.com>
This commit is contained in:
Carter Snook 2021-04-25 22:59:22 -05:00 committed by GitHub
parent f3751e498f
commit 0897bd51a0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -89,7 +89,7 @@ declare namespace Deno {
/** The current process id of the runtime. */ /** The current process id of the runtime. */
export const pid: number; export const pid: number;
/** Reflects the `NO_COLOR` environment variable. /** Reflects the `NO_COLOR` environment variable at program start.
* *
* See: https://no-color.org/ */ * See: https://no-color.org/ */
export const noColor: boolean; export const noColor: boolean;
@ -426,7 +426,7 @@ declare namespace Deno {
/** /**
* @deprecated Use iter from https://deno.land/std/io/util.ts instead. Deno.iter will be removed in Deno 2.0. * @deprecated Use iter from https://deno.land/std/io/util.ts instead. Deno.iter will be removed in Deno 2.0.
* *
* Turns a Reader, `r`, into an async iterator. * Turns a Reader, `r`, into an async iterator.
* *
* ```ts * ```ts
@ -465,7 +465,7 @@ declare namespace Deno {
/** /**
* @deprecated Use iterSync from https://deno.land/std/io/util.ts instead. Deno.iterSync will be removed in Deno 2.0. * @deprecated Use iterSync from https://deno.land/std/io/util.ts instead. Deno.iterSync will be removed in Deno 2.0.
* *
* Turns a ReaderSync, `r`, into an iterator. * Turns a ReaderSync, `r`, into an iterator.
* *
* ```ts * ```ts
@ -851,7 +851,7 @@ declare namespace Deno {
/** /**
* @deprecated Use Buffer from https://deno.land/std/io/buffer.ts instead. Deno.Buffer will be removed in Deno 2.0. * @deprecated Use Buffer from https://deno.land/std/io/buffer.ts instead. Deno.Buffer will be removed in Deno 2.0.
* *
* A variable-sized buffer of bytes with `read()` and `write()` methods. * A variable-sized buffer of bytes with `read()` and `write()` methods.
* *
* Deno.Buffer is almost always used with some I/O like files and sockets. It * Deno.Buffer is almost always used with some I/O like files and sockets. It
@ -934,7 +934,7 @@ declare namespace Deno {
/** /**
* @deprecated Use readAll from https://deno.land/std/io/util.ts instead. Deno.readAll will be removed in Deno 2.0. * @deprecated Use readAll from https://deno.land/std/io/util.ts instead. Deno.readAll will be removed in Deno 2.0.
* *
* Read Reader `r` until EOF (`null`) and resolve to the content as * Read Reader `r` until EOF (`null`) and resolve to the content as
* Uint8Array`. * Uint8Array`.
* *
@ -958,7 +958,7 @@ declare namespace Deno {
/** /**
* @deprecated Use readAllSync from https://deno.land/std/io/util.ts instead. Deno.readAllSync will be removed in Deno 2.0. * @deprecated Use readAllSync from https://deno.land/std/io/util.ts instead. Deno.readAllSync will be removed in Deno 2.0.
* *
* Synchronously reads Reader `r` until EOF (`null`) and returns the content * Synchronously reads Reader `r` until EOF (`null`) and returns the content
* as `Uint8Array`. * as `Uint8Array`.
* *
@ -982,7 +982,7 @@ declare namespace Deno {
/** /**
* @deprecated Use writeAll from https://deno.land/std/io/util.ts instead. Deno.readAll will be removed in Deno 2.0. * @deprecated Use writeAll from https://deno.land/std/io/util.ts instead. Deno.readAll will be removed in Deno 2.0.
* *
* Write all the content of the array buffer (`arr`) to the writer (`w`). * Write all the content of the array buffer (`arr`) to the writer (`w`).
* *
* ```ts * ```ts
@ -1007,7 +1007,7 @@ declare namespace Deno {
/** /**
* @deprecated Use writeAllSync from https://deno.land/std/io/util.ts instead. Deno.writeAllSync will be removed in Deno 2.0. * @deprecated Use writeAllSync from https://deno.land/std/io/util.ts instead. Deno.writeAllSync will be removed in Deno 2.0.
* *
* Synchronously write all the content of the array buffer (`arr`) to the * Synchronously write all the content of the array buffer (`arr`) to the
* writer (`w`). * writer (`w`).
* *
@ -2350,7 +2350,7 @@ declare namespace Deno {
* if the file previously was larger than this new length, the extra data is lost. * if the file previously was larger than this new length, the extra data is lost.
* *
* if the file previously was shorter, it is extended, and the extended part reads as null bytes ('\0'). * if the file previously was shorter, it is extended, and the extended part reads as null bytes ('\0').
* *
* ```ts * ```ts
* // truncate the entire file * // truncate the entire file
* const file = Deno.open("my_file.txt", { read: true, write: true, truncate: true, create: true }); * const file = Deno.open("my_file.txt", { read: true, write: true, truncate: true, create: true });
@ -2392,7 +2392,7 @@ declare namespace Deno {
*/ */
export function ftruncate(rid: number, len?: number): Promise<void>; export function ftruncate(rid: number, len?: number): Promise<void>;
/** /**
* Synchronously returns a `Deno.FileInfo` for the given file stream. * Synchronously returns a `Deno.FileInfo` for the given file stream.
* *
* ```ts * ```ts