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

docs(cli/dts): fix Deno.inspect examples (#10569)

Browse source
This commit is contained in:
Casper Beyer 2021-05-11 10:17:07 +08:00 committed by GitHub
parent 2b8376db24
commit ba8d6ec771
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
cli/dts/lib.deno.ns.d.ts vendored
View file

@ -2122,11 +2122,12 @@ declare namespace Deno {
* `console.log()`.
*
* ```ts
* const obj = {};
* obj.propA = 10;
* obj.propB = "hello";
* const objAsString = Deno.inspect(obj); // { propA: 10, propB: "hello" }
* console.log(obj); // prints same value as objAsString, e.g. { propA: 10, propB: "hello" }
* const obj = {
* a: 10,
* b: "hello",
* };
* const objAsString = Deno.inspect(obj); // { a: 10, b: "hello" }
* console.log(obj); // prints same value as objAsString, e.g. { a: 10, b: "hello" }
* ```
*
* You can also register custom inspect functions, via the `customInspect` Deno
@ -2140,15 +2141,16 @@ declare namespace Deno {
* return "x=" + this.x + ", y=" + this.y;
* }
* }
* ```
*
* const inStringFormat = Deno.inspect(new A()); // "x=10, y=hello"
* console.log(inStringFormat); // prints "x=10, y=hello"
* const inStringFormat = Deno.inspect(new A()); // "x=10, y=hello"
* console.log(inStringFormat); // prints "x=10, y=hello"
* ```
*
* Finally, you can also specify the depth to which it will format.
*
* Deno.inspect({a: {b: {c: {d: 'hello'}}}}, {depth: 2}); // { a: { b: [Object] } }
*
* ```ts
* Deno.inspect({a: {b: {c: {d: 'hello'}}}}, {depth: 2}); // { a: { b: [Object] } }
* ```
*/
export function inspect(value: unknown, options?: InspectOptions): string;