CodeParseResult
interface exported by @mwillbanks/tuil-code.
interface
Public interface exported by @mwillbanks/tuil-code.
export interface CodeParseResult {
readonly language: string;
readonly version: number;
readonly spans: readonly CodeSpan[];
readonly folds: readonly {
readonly startLine: number;
readonly endLine: number;
}[];
readonly diagnostics: readonly CodeDiagnostic[];
readonly incremental?: boolean;
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
language | string | Yes | The language member uses the string contract. | — |
version | number | Yes | The version member uses the number contract. | — |
spans | readonly CodeSpan[] | Yes | The spans member uses the readonly CodeSpan[] contract. | CodeSpan |
folds | readonly { readonly startLine: number; readonly endLine: number; }[] | Yes | The folds member uses the readonly { readonly startLine: number; readonly endLine: number; }[] contract. | — |
diagnostics | readonly CodeDiagnostic[] | Yes | The diagnostics member uses the readonly CodeDiagnostic[] contract. | CodeDiagnostic |
incremental | boolean | undefined | No | The incremental member uses the boolean | undefined 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