PartialDocument
interface exported by @mwillbanks/tuil-streaming.
interface
Public interface exported by @mwillbanks/tuil-streaming.
export interface PartialDocument {
readonly format: string;
readonly complete: boolean;
readonly root: DocumentNode;
readonly diagnostics: readonly ParserDiagnostic[];
readonly source: string;
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
format | string | Yes | The format member uses the string contract. | — |
complete | boolean | Yes | The complete member uses the boolean contract. | — |
root | DocumentNode | Yes | The root member uses the DocumentNode contract. | DocumentNode |
diagnostics | readonly ParserDiagnostic[] | Yes | The diagnostics member uses the readonly ParserDiagnostic[] contract. | ParserDiagnostic |
source | string | Yes | The source member uses the string contract. | — |
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