YAML.parseAllDocuments | /deps.ts | aether@v0.0.3

Module

x/aether/deps.ts>YAML.parseAllDocuments

A Deno library to interface with the Discord API

Cqdet/Aether

Latest

src

mod.ts (default module)

CreateCollectionOptions

TimeSeriesGranularity

function YAML.parseAllDocuments

import { YAML } from "https://deno.land/x/aether@v0.0.3/deps.ts";
const { parseAllDocuments } = YAML;

parseAllDocuments<T extends ParsedNode = ParsedNode>(source: string, options?: ParseOptions & DocumentOptions & SchemaOptions): 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

optional

T extends ParsedNode = ParsedNode

Parameters

source: string

optional

options: ParseOptions & DocumentOptions & SchemaOptions

Returns

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.