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

Inspectable.ts overview

Since v2.0.0


Exports Grouped by Category


models

Inspectable (interface)

Signature

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

Source

Since v2.0.0

redactable

Redactable (interface)

Signature

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

Source

Since v3.10.0

isRedactable

Signature

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

Source

Since v3.10.0

redact

Signature

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

Source

Since v3.10.0

symbolRedactable

Signature

declare const symbolRedactable: unique symbol

Source

Since v3.10.0

withRedactableContext

Signature

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

Source

Since v3.10.0

symbols

NodeInspectSymbol

Signature

declare const NodeInspectSymbol: unique symbol

Source

Since v2.0.0

NodeInspectSymbol (type alias)

Signature

type NodeInspectSymbol = typeof NodeInspectSymbol

Source

Since v2.0.0

utils

BaseProto

Signature

declare const BaseProto: Inspectable

Source

Since v2.0.0

Class (class)

Signature

declare class Class

Source

Since v2.0.0

toJSON (method)

Signature

declare const toJSON: () => unknown

Source

Since v2.0.0

[NodeInspectSymbol] (method)

Signature

declare const [NodeInspectSymbol]: () => unknown

Source

Since v2.0.0

toString (method)

Signature

declare const toString: () => string

Source

Since v2.0.0

format

Signature

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

Source

Since v2.0.0

stringifyCircular

Signature

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

Source

Since v2.0.0

toJSON

Signature

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

Source

Since v2.0.0

toStringUnknown

Signature

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

Source

Since v2.0.0