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

Function parseDocument

  • parseDocument<Contents, Strict>(source, options?): Contents extends ParsedNode
        ? yaml.Document.Parsed<Contents, Strict>
        : yaml.Document<Contents, Strict>
  • Parse an input string into a single YAML.Document

    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>

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

Settings

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

Generated using TypeDoc