import { Composer } from './compose/composer.js'; import type { Reviver } from './doc/applyReviver.js'; import { Document, Replacer } from './doc/Document.js'; import type { ParsedNode } from './nodes/Node.js'; import type { CreateNodeOptions, DocumentOptions, ParseOptions, SchemaOptions, ToJSOptions, ToStringOptions } from './options.js'; export interface EmptyStream extends Array, ReturnType { empty: true; } /** * Parse the input as a stream of YAML documents. * * Documents should be separated from each other by `...` or `---` marker lines. * * @returns 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. */ export declare function parseAllDocuments(source: string, options?: ParseOptions & DocumentOptions & SchemaOptions): Document.Parsed[] | EmptyStream; /** Parse an input string into a single YAML.Document */ export declare function parseDocument(source: string, options?: ParseOptions & DocumentOptions & SchemaOptions): Document.Parsed; /** * Parse an input string into JavaScript. * * Only supports input consisting of a single YAML document; for multi-document * support you should use `YAML.parseAllDocuments`. May throw on error, and may * log warnings using `console.warn`. * * @param str - A string with YAML formatting. * @param reviver - A reviver function, as in `JSON.parse()` * @returns The value will match the type of the root value of the parsed YAML * document, so Maps become objects, Sequences arrays, and scalars result in * nulls, booleans, numbers and strings. */ export declare function parse(src: string, options?: ParseOptions & DocumentOptions & SchemaOptions & ToJSOptions): any; export declare function parse(src: string, reviver: Reviver, options?: ParseOptions & DocumentOptions & SchemaOptions & ToJSOptions): any; /** * Stringify a value as a YAML document. * * @param replacer - A replacer array or function, as in `JSON.stringify()` * @returns Will always include `\n` as the last character, as is expected of YAML documents. */ export declare function stringify(value: any, options?: DocumentOptions & SchemaOptions & ParseOptions & CreateNodeOptions & ToStringOptions): string; export declare function stringify(value: any, replacer?: Replacer | null, options?: string | number | (DocumentOptions & SchemaOptions & ParseOptions & CreateNodeOptions & ToStringOptions)): string;