• Preparing search index...
  • The search index is not available
Yank Note Api - v3.88.2
  • Yank Note Api
  • renderer/context/lib
  • yaml
  • parseAllDocuments

Function parseAllDocuments

  • parseAllDocuments<Contents, Strict>(source, options?): (Contents extends ParsedNode
        ? yaml.Document.Parsed<Contents, Strict>
        : yaml.Document<Contents, Strict>)[] | EmptyStream
  • Parse the input as a stream of YAML documents.

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

    Type Parameters

    • Contents extends yaml.Node = ParsedNode
    • Strict extends boolean = true

    Parameters

    • source: string
    • Optionaloptions: ParseOptions & DocumentOptions & SchemaOptions

    Returns (Contents extends ParsedNode
        ? yaml.Document.Parsed<Contents, Strict>
        : yaml.Document<Contents, Strict>)[] | 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.

    • Defined in node_modules/yaml/dist/public-api.d.ts:19

Settings

Member Visibility
Yank Note Api - v3.88.2
  • Loading...

Generated using TypeDoc