Function parseAllDocuments

  • parseAllDocuments<T>(source, options?): yaml.Document.Parsed<T>[] | EmptyStream

  • Parse the input as a stream of YAML documents.

    Documents should be separated from each other by ... or --- marker lines.

    Type Parameters

    Parameters

    Returns yaml.Document.Parsed<T>[] | EmptyStream

    If an empty docs array is returned, it will be of type EmptyStream and contain additional stream information. In TypeScript, you should use 'empty' in docs as a type guard for it.

Settings

Member Visibility

Theme

Generated using TypeDoc