Class Composer

Compose a stream of CST nodes into a stream of YAML Documents.

import { Composer, Parser } from 'yaml'

const src: string = ...
const tokens = new Parser().parse(src)
const docs = new Composer().compose(tokens)

Constructors

constructor

Methods

compose end next streamInfo

Constructors

constructor

Methods

compose

  • compose(tokens, forceDoc?, endOffset?): Generator<yaml.Document.Parsed<ParsedNode>, void, unknown>

  • Compose tokens into documents.

    Parameters

    • tokens: Iterable<yaml.CST.Token>
    • OptionalforceDoc: boolean

      If the stream contains no document, still emit a final document including any comments and directives that would be applied to a subsequent document.

    • OptionalendOffset: number

      Should be set if forceDoc is also set, to set the document range end and to indicate errors correctly.

    Returns Generator<yaml.Document.Parsed<ParsedNode>, void, unknown>

end

  • end(forceDoc?, endOffset?): Generator<yaml.Document.Parsed<ParsedNode>, void, unknown>

  • Call at end of input to yield any remaining document.

    Parameters

    • OptionalforceDoc: boolean

      If the stream contains no document, still emit a final document including any comments and directives that would be applied to a subsequent document.

    • OptionalendOffset: number

      Should be set if forceDoc is also set, to set the document range end and to indicate errors correctly.

    Returns Generator<yaml.Document.Parsed<ParsedNode>, void, unknown>

next

streamInfo

  • streamInfo(): {
        comment: string;
        directives: Directives;
        errors: YAMLParseError[];
        warnings: YAMLWarning[];
    }

  • Current stream status information.

    Mostly useful at the end of input for an empty stream.

    Returns {
        comment: string;
        directives: Directives;
        errors: YAMLParseError[];
        warnings: YAMLWarning[];
    }

Settings

Member Visibility

On This Page

Constructors
Methods