Documentation
    Preparing search index...

    Interface CustomInspectableObject

    Provides methods on objects to customize how the objects are rendered in various inspectors.

    Please refer to the documentation of respective member for details.

    interface CustomInspectableObject {
        "[ChaiInspectSymbol]"?: (options: unknown) => unknown;
        "[NodeJSInspectCustomSymbol]"?: CustomInspectFunction;
    }
    Index

    Properties

    "[ChaiInspectSymbol]"?: (options: unknown) => unknown

    Customizes how the current object is rendered when inspected with loupe package.

    Type declaration

      • (options: unknown): unknown
      • Parameters

        Returns unknown

        a string as the representation of current object, or other values that will be rendered again by loupe.

    "[NodeJSInspectCustomSymbol]"?: CustomInspectFunction

    Objects may also define their own [util.inspect.custom](depth, opts, inspect) function, which util.inspect() will invoke and use the result of when inspecting the object.