CodeParser

interface

Public interface exported by @mwillbanks/tuil-code.

export interface CodeParser {
  readonly id: string;
  readonly languages: readonly string[];
  parse(
    source: string,
    options: {
      readonly previous?: CodeParseResult;
      readonly signal: AbortSignal;
    },
  ): CodeParseResult | Promise<CodeParseResult>;
  dispose?(): void;
}

Members

Member	Type	Required	Description	Related types
`id`	`string`	Yes	The `id` member uses the `string` contract.	—
`languages`	`readonly string[]`	Yes	The `languages` member uses the `readonly string[]` contract.	—
`parse`	`(source: string, options: { readonly previous?: CodeParseResult; readonly signal: AbortSignal; }) => CodeParseResult \| Promise<CodeParseResult>`	Yes	The `parse` member uses the `(source: string, options: { readonly previous?: CodeParseResult; readonly signal: AbortSignal; }) => CodeParseResult \| Promise<CodeParseResult>` contract.	`CodeParseResult`
`dispose`	`(() => void) \| undefined`	No	The `dispose` member uses the `(() => void) \| 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.

CodeParseResult

Source

View the secondary source reference

Package

@mwillbanks/tuil-code

On this page