Interface Entry<T>

One renderable kind.

interface Entry<T = any> {
    kind: string;
    is(target: unknown): target is T;
    render(target: T, options?: Renderer.Options): string | Promise<string>;
}

Type Parameters

T = any

Index

Properties

Methods

Properties

`Readonly`kind

kind: string

Registry key — the kind name an explicit lookup (describe('sheet', …)) uses.

Methods

is

is(target: unknown): target is T
Detects whether this entry accepts the object — the dynamic-dispatch path.
Parameters
- target: unknown
Returns target is T

render

render(target: T, options?: Renderer.Options): string | Promise<string>
Renders the object as its markdown report.
Parameters
- target: T
- Optionaloptions: Renderer.Options
Returns string | Promise<string>