DocumentNode
interface exported by @mwillbanks/tuil-streaming.
interface
Public interface exported by @mwillbanks/tuil-streaming.
export interface DocumentNode {
readonly type: string;
readonly value?: unknown;
readonly raw?: string;
readonly span?: SourceSpan;
readonly attributes?: Readonly<Record<string, unknown>>;
readonly children?: readonly DocumentNode[];
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
type | string | Yes | The type member uses the string contract. | — |
value | unknown | No | The value member uses the unknown contract. | — |
raw | string | undefined | No | The raw member uses the string | undefined contract. | — |
span | SourceSpan | undefined | No | The span member uses the SourceSpan | undefined contract. | SourceSpan |
attributes | Readonly<Record<string, unknown>> | undefined | No | The attributes member uses the Readonly<Record<string, unknown>> | undefined contract. | — |
children | readonly DocumentNode[] | undefined | No | The children member uses the readonly DocumentNode[] | undefined contract. | DocumentNode |
Parameters
This declaration has no public members.
Returns
This declaration does not return a value.
Throws
No thrown errors are documented for this declaration.
Related types
Source
View the secondary source reference