Skip to main content Link Search Menu Expand Document (external link)

Inspectable overview

Added in v2.0.0


Table of contents


models

Inspectable (interface)

Signature

export interface Inspectable {
  toString(): string
  toJSON(): unknown
  [NodeInspectSymbol](): unknown
}

Added in v2.0.0

redactable

Redactable (interface)

Signature

export interface Redactable {
  readonly [symbolRedactable]: (fiberRefs: FiberRefs.FiberRefs) => unknown
}

Added in v3.10.0

isRedactable

Signature

export declare const isRedactable: (u: unknown) => u is Redactable

Added in v3.10.0

redact

Signature

export declare const redact: (u: unknown) => unknown

Added in v3.10.0

symbolRedactable

Signature

export declare const symbolRedactable: typeof symbolRedactable

Added in v3.10.0

withRedactableContext

Signature

export declare const withRedactableContext: <A>(context: FiberRefs.FiberRefs, f: () => A) => A

Added in v3.10.0

symbols

NodeInspectSymbol

Signature

export declare const NodeInspectSymbol: typeof NodeInspectSymbol

Added in v2.0.0

NodeInspectSymbol (type alias)

Signature

export type NodeInspectSymbol = typeof NodeInspectSymbol

Added in v2.0.0

utils

BaseProto

Signature

export declare const BaseProto: Inspectable

Added in v2.0.0

Class (class)

Signature

export declare class Class

Added in v2.0.0

toJSON (method)

Signature

abstract toJSON(): unknown

Added in v2.0.0

[NodeInspectSymbol] (method)

Signature

;[NodeInspectSymbol]()

Added in v2.0.0

toString (method)

Signature

toString()

Added in v2.0.0

format

Signature

export declare const format: (x: unknown) => string

Added in v2.0.0

stringifyCircular

Signature

export declare const stringifyCircular: (obj: unknown, whitespace?: number | string | undefined) => string

Added in v2.0.0

toJSON

Signature

export declare const toJSON: (x: unknown) => unknown

Added in v2.0.0

toStringUnknown

Signature

export declare const toStringUnknown: (u: unknown, whitespace?: number | string | undefined) => string

Added in v2.0.0