Class: Navigator¶

Constructors¶

new Navigator(host): Navigator;

Parameter	Type
`host`	`ManifestInstance`

Navigator

describe(kind, name): string;

Describe a single document. Equivalent to mi.describe(kind, name).

Parameter	Type
`kind`	`string`
`name`	`string`

string

inventory(): Record<string, unknown>;

Produce a structured inventory of the manifest. Equivalent to mi.inventory().

Record\<string, unknown>

renderDoc(kind, name): PreviewBlock[];

Polymorphic per-kind preview. Equivalent to mi.renderDoc(kind, name).

Parameter	Type
`kind`	`string`
`name`	`string`

summary(): string;

Produce a text summary of the manifest. Equivalent to mi.summary().

string