Skip to main content
Deno.inspect - Deno documentation
function Deno.inspect
inspect(
value: unknown,
options?: InspectOptions,
): string

Converts the input into a string that has the same format as printed by console.log().

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" }

A custom inspect functions can be registered on objects, via the symbol Symbol.for("Deno.customInspect"), to control and customize the output of inspect() or when using console logging:

class A {
  x = 10;
  y = "hello";
  [Symbol.for("Deno.customInspect")]() {
    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"

A depth can be specified by using the depth option:

Deno.inspect({a: {b: {c: {d: 'hello'}}}}, {depth: 2}); // { a: { b: [Object] } }

Parameters

value: unknown
optional
options: InspectOptions

Return Type

string
Back to top