0.1.0-alpha.7

@zerolith/devtools

Import from @zerolith/devtools. Generated from the source; every signature below is what the published types declare.

Functions

describeValue

function describeValue(value: unknown): string

A short, safe textual form of a value for the table.

Source: packages/devtools/src/index.ts:41

mountDevtools

function mountDevtools(options?: DevtoolsOptions): DevtoolsHandle

Mounts the inspector dock at the bottom of the page. Returns a handle to toggle or remove it. Everything the inspector creates is marked internal so it does not appear in its own tables. Mounting fails with package_version_mismatch when the installed zerolith is not the version the inspector was released with.

Source: packages/devtools/src/index.ts:137

Interfaces

DevtoolsHandle

interface DevtoolsHandle

The handle returned by mountDevtools.

  • toggle(open?: boolean): void: Shows or hides the dock.
  • dispose(): void: Removes the dock.

Source: packages/devtools/src/noop.ts:13

DevtoolsOptions

interface DevtoolsOptions

Options for mountDevtools.

  • open?: boolean: Start with the dock open. Defaults to false.

Source: packages/devtools/src/noop.ts:6