yaml 3.0.0-1 → 3.0.0-2

package/dist/index.d.ts

@@ -1,17 +1,16 @@
-import { A as CollectionTag, C as DocumentOptions, D as ToStringOptions, E as ToJSOptions, F as Scalar, G as YAMLParseError, H as Reviver, K as YAMLWarning, L as ToJSContext, M as Pair, N as KeyArg, O as TagId, P as YAMLMap, R as StringifyContext, S as CreateNodeOptions, T as SchemaOptions, U as ErrorCode, W as YAMLError, a as Alias, c as Node, d as Range, f as YAMLSet, i as Replacer, j as ScalarTag, k as Tags, l as NodeBase, n as DocValue, o as Token, q as LineCounter, r as Document, s as cst_d_exports, t as Directives, u as Primitive, w as ParseOptions, x as Schema, y as YAMLSeq } from "./directives-DlYEVlkC.js";
-
+import { A as CollectionTag, C as DocumentOptions, D as ToStringOptions, E as ToJSOptions, F as Scalar, G as YAMLParseError, H as Reviver, K as YAMLWarning, L as ToJSContext, M as Pair, N as KeyArg, O as TagId, P as YAMLMap, R as StringifyContext, S as CreateNodeOptions, T as SchemaOptions, U as ErrorCode, W as YAMLError, a as Alias, c as Node, d as Range, f as YAMLSet, i as Replacer, j as ScalarTag, k as Tags, l as NodeBase, n as DocValue, o as Token, q as LineCounter, r as Document, s as cst_d_exports, t as Directives, u as Primitive, w as ParseOptions, x as Schema, y as YAMLSeq } from "./directives-CGITitH5.js";
 //#region src/compose/composer.d.ts
 /**
-* Compose a stream of CST nodes into a stream of YAML Documents.
-*
-* ```ts
-* import { Composer, Parser } from 'yaml'
-*
-* const src: string = ...
-* const tokens = new Parser().parse(src)
-* const docs = new Composer().compose(tokens)
-* ```
-*/
+ * Compose a stream of CST nodes into a stream of YAML Documents.
+ *
+ * ```ts
+ * import { Composer, Parser } from 'yaml'
+ *
+ * const src: string = ...
+ * const tokens = new Parser().parse(src)
+ * const docs = new Composer().compose(tokens)
+ * ```
+ */
 declare class Composer<Value extends DocValue = DocValue, Strict extends boolean = true> {
   private directives;
   private doc;
@@ -25,10 +24,10 @@ declare class Composer<Value extends DocValue = DocValue, Strict extends boolean
   private onError;
   private decorate;
   /**
-  * Current stream status information.
-  *
-  * Mostly useful at the end of input for an empty stream.
-  */
+   * Current stream status information.
+   *
+   * Mostly useful at the end of input for an empty stream.
+   */
   streamInfo(): {
     comment: string;
     directives: Directives;
@@ -36,20 +35,20 @@ declare class Composer<Value extends DocValue = DocValue, Strict extends boolean
     warnings: YAMLWarning[];
   };
   /**
-  * Compose tokens into documents.
-  *
-  * @param forceDoc - If the stream contains no document, still emit a final document including any comments and directives that would be applied to a subsequent document.
-  * @param endOffset - Should be set if `forceDoc` is also set, to set the document range end and to indicate errors correctly.
-  */
+   * Compose tokens into documents.
+   *
+   * @param forceDoc - If the stream contains no document, still emit a final document including any comments and directives that would be applied to a subsequent document.
+   * @param endOffset - Should be set if `forceDoc` is also set, to set the document range end and to indicate errors correctly.
+   */
   compose(tokens: Iterable<Token>, forceDoc?: boolean, endOffset?: number): Document.Parsed<Value, Strict>[];
   /** Advance the composer by one CST token. */
   next(token: Token): void;
   /**
-  * Call at end of input to handle any remaining document.
-  *
-  * @param forceDoc - If the stream contains no document, still emit a final document including any comments and directives that would be applied to a subsequent document.
-  * @param endOffset - Should be set if `forceDoc` is also set, to set the document range end and to indicate errors correctly.
-  */
+   * Call at end of input to handle any remaining document.
+   *
+   * @param forceDoc - If the stream contains no document, still emit a final document including any comments and directives that would be applied to a subsequent document.
+   * @param endOffset - Should be set if `forceDoc` is also set, to set the document range end and to indicate errors correctly.
+   */
   end(forceDoc?: boolean, endOffset?: number): Document.Parsed<Value, Strict>[];
 }
 //#endregion
@@ -61,47 +60,47 @@ declare const isNode: (node: unknown) => node is Node;
 //#endregion
 //#region src/parse/lexer.d.ts
 /**
-* Splits an input `source` string into lexical YAML tokens,
-* i.e. smaller strings that are easily identifiable by `tokens.tokenType()`.
-*
-* Lexing starts always in a "stream" context.
-*
-* In addition to slices of the original input, the following control characters
-* may also be emitted:
-*
-* - `\x02` (Start of Text): A document starts with the next token
-* - `\x18` (Cancel): Unexpected end of flow-mode (indicates an error)
-* - `\x1f` (Unit Separator): Next token is a scalar value
-* - `\u{FEFF}` (Byte order mark): Emitted separately outside documents
-*/
+ * Splits an input `source` string into lexical YAML tokens,
+ * i.e. smaller strings that are easily identifiable by `tokens.tokenType()`.
+ *
+ * Lexing starts always in a "stream" context.
+ *
+ * In addition to slices of the original input, the following control characters
+ * may also be emitted:
+ *
+ * - `\x02` (Start of Text): A document starts with the next token
+ * - `\x18` (Cancel): Unexpected end of flow-mode (indicates an error)
+ * - `\x1f` (Unit Separator): Next token is a scalar value
+ * - `\u{FEFF}` (Byte order mark): Emitted separately outside documents
+ */
 declare function lex(source: string): string[];
 //#endregion
 //#region src/parse/parser.d.ts
 /**
-* A YAML concrete syntax tree (CST) parser
-*
-* ```ts
-* const src: string = ...
-* for (const token of new Parser().parse(src)) {
-*   // token: Token
-* }
-* ```
-*
-* To use the parser with a user-provided lexer:
-*
-* ```ts
-* function parse(source: string, lexTokens: string[]) {
-*   const parser = new Parser()
-*   for (const lexeme of lexTokens) parser.next(lexeme)
-*   return parser.end()
-* }
-*
-* const src: string = ...
-* for (const token of parse(src, lex(src))) {
-*   // token: Token
-* }
-* ```
-*/
+ * A YAML concrete syntax tree (CST) parser
+ *
+ * ```ts
+ * const src: string = ...
+ * for (const token of new Parser().parse(src)) {
+ *   // token: Token
+ * }
+ * ```
+ *
+ * To use the parser with a user-provided lexer:
+ *
+ * ```ts
+ * function parse(source: string, lexTokens: string[]) {
+ *   const parser = new Parser()
+ *   for (const lexeme of lexTokens) parser.next(lexeme)
+ *   return parser.end()
+ * }
+ *
+ * const src: string = ...
+ * for (const token of parse(src, lex(src))) {
+ *   // token: Token
+ * }
+ * ```
+ */
 declare class Parser {
   private onNewLine?;
   /** If true, space and sequence indicators count as indentation */
@@ -122,21 +121,21 @@ declare class Parser {
   private type;
   tokens: Token[];
   /**
-  * @param onNewLine - If defined, called separately with the start position of
-  *   each new line (in `parse()`, including the start of input).
-  */
+   * @param onNewLine - If defined, called separately with the start position of
+   *   each new line (in `parse()`, including the start of input).
+   */
   constructor(onNewLine?: (offset: number) => void);
   /**
-  * Parse `source` as a YAML stream.
-  *
-  * Errors are not thrown, but included in the result as `{ type: 'error', message }` tokens.
-  *
-  * @returns Tokens representing each directive, document, and other structure.
-  */
+   * Parse `source` as a YAML stream.
+   *
+   * Errors are not thrown, but included in the result as `{ type: 'error', message }` tokens.
+   *
+   * @returns Tokens representing each directive, document, and other structure.
+   */
   parse(source: string): Token[];
   /**
-  * Advance the parser by the `source` of one lexical token.
-  */
+   * Advance the parser by the `source` of one lexical token.
+   */
   next(source: string): void;
   /** Call at end of input to account for any remaining constructions */
   end(): Token[];
@@ -163,38 +162,38 @@ interface EmptyStream extends Array<Document.Parsed>, ReturnType<Composer["strea
   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.
-*/
+ * 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.
+ */
 declare function parseAllDocuments<Value extends DocValue = DocValue, Strict extends boolean = true>(source: string, options?: ParseOptions & DocumentOptions & SchemaOptions): Document.Parsed<Value, Strict>[] | EmptyStream;
 /** Parse an input string into a single YAML.Document */
 declare function parseDocument<Value extends DocValue = DocValue, Strict extends boolean = true>(source: string, options?: ParseOptions & DocumentOptions & SchemaOptions): Document.Parsed<Value, Strict>;
 /**
-* 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.
-*/
+ * 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.
+ */
 declare function parse(src: string, options?: ParseOptions & DocumentOptions & SchemaOptions & ToJSOptions): any;
 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.
-*/
+ * 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.
+ */
 declare function stringify(value: any, options?: DocumentOptions & SchemaOptions & ParseOptions & CreateNodeOptions & ToStringOptions): string;
 declare function stringify(value: any, replacer?: Replacer | null, options?: string | number | (DocumentOptions & SchemaOptions & ParseOptions & CreateNodeOptions & ToStringOptions)): string;
 //#endregion
@@ -202,19 +201,19 @@ declare function stringify(value: any, replacer?: Replacer | null, options?: str
 declare class YAMLOMap<K extends Primitive | Node = Primitive | Node, V extends Primitive | Node = Primitive | Node> extends YAMLSeq<Pair<K, V>> {
   constructor(schema: Schema, elements?: Array<Pair<K, V>>);
   /**
-  * Append new pairs to the omap, and return its new length.
-  */
+   * Append new pairs to the omap, and return its new length.
+   */
   push(...pairs: Pair<K, V>[]): number;
   /**
-  * Set a pair in this omap.
-  *
-  * Throws if `idx` is not an integer.
-  */
+   * Set a pair in this omap.
+   *
+   * Throws if `idx` is not an integer.
+   */
   set(idx: number, pair: Pair<K, V>): void;
   /**
-  * The returned value actually has type `Map<unknown, unknown>`,
-  * but TypeScript won't allow widening the signature of a child method.
-  */
+   * The returned value actually has type `Map<unknown, unknown>`,
+   * but TypeScript won't allow widening the signature of a child method.
+   */
   toJS(doc: Document<DocValue, boolean>, ctx?: ToJSContext): never[];
   toString(ctx?: StringifyContext, onComment?: () => void, onChompKeep?: () => void): string;
 }
@@ -243,77 +242,83 @@ type asyncVisitor = asyncVisitorFn<Node | Pair | null> | {
   Value?: asyncVisitorFn<Scalar | YAMLMap | YAMLSeq | YAMLSet>;
 };
 /**
-* Apply a visitor to an AST node or document.
-*
-* Walks through the tree (depth-first) starting from `node`, calling a
-* `visitor` function with three arguments:
-*   - `key`: For sequence values and map `Pair`, the node's index in the
-*     collection. Within a `Pair`, `'key'` or `'value'`, correspondingly.
-*     `null` for the root node.
-*   - `node`: The current node.
-*   - `path`: The ancestry of the current node.
-*
-* The return value of the visitor may be used to control the traversal:
-*   - `undefined` (default): Do nothing and continue
-*   - `visit.SKIP`: Do not visit the children of this node, continue with next
-*     sibling
-*   - `visit.BREAK`: Terminate traversal completely
-*   - `visit.REMOVE`: Remove the current node, then continue with the next one
-*   - `Node`: Replace the current node, then continue by visiting it
-*   - `number`: While iterating the items of a sequence or map, set the index
-*     of the next step. This is useful especially if the index of the current
-*     node has changed.
-*
-* If `visitor` is a single function, it will be called with all values
-* encountered in the tree, including e.g. `null` values. Alternatively,
-* separate visitor functions may be defined for each `Map`, `Pair`, `Seq`,
-* `Alias` and `Scalar` node. To define the same visitor function for more than
-* one node type, use the `Collection` (map and seq), `Value` (map, seq & scalar)
-* and `Node` (alias, map, seq & scalar) targets. Of all these, only the most
-* specific defined one will be used for each node.
-*/
+ * Apply a visitor to an AST node or document.
+ *
+ * Walks through the tree (depth-first) starting from `node`, calling a
+ * `visitor` function with three arguments:
+ *   - `key`: For sequence values and map `Pair`, the node's index in the
+ *     collection. Within a `Pair`, `'key'` or `'value'`, correspondingly.
+ *     `null` for the root node.
+ *   - `node`: The current node.
+ *   - `path`: The ancestry of the current node.
+ *
+ * The return value of the visitor may be used to control the traversal:
+ *   - `undefined` (default): Do nothing and continue
+ *   - `visit.SKIP`: Do not visit the children of this node, continue with next
+ *     sibling
+ *   - `visit.BREAK`: Terminate traversal completely
+ *   - `visit.REMOVE`: Remove the current node, then continue with the next one
+ *   - `Node`: Replace the current node, then continue by visiting it
+ *   - `number`: While iterating the items of a sequence or map, set the index
+ *     of the next step. This is useful especially if the index of the current
+ *     node has changed.
+ *
+ * If `visitor` is a single function, it will be called with all values
+ * encountered in the tree, including e.g. `null` values. Alternatively,
+ * separate visitor functions may be defined for each `Map`, `Pair`, `Seq`,
+ * `Alias` and `Scalar` node. To define the same visitor function for more than
+ * one node type, use the `Collection` (map and seq), `Value` (map, seq & scalar)
+ * and `Node` (alias, map, seq & scalar) targets. Of all these, only the most
+ * specific defined one will be used for each node.
+ */
 declare const visit: {
-  (node: Node | Document | null, visitor: visitor): void; /** Terminate visit traversal completely */
-  BREAK: symbol; /** Do not visit the children of the current node */
-  SKIP: symbol; /** Remove the current node */
+  (node: Node | Document | null, visitor: visitor): void;
+  /** Terminate visit traversal completely */
+  BREAK: symbol;
+  /** Do not visit the children of the current node */
+  SKIP: symbol;
+  /** Remove the current node */
   REMOVE: symbol;
 };
 /**
-* Apply an async visitor to an AST node or document.
-*
-* Walks through the tree (depth-first) starting from `node`, calling a
-* `visitor` function with three arguments:
-*   - `key`: For sequence values and map `Pair`, the node's index in the
-*     collection. Within a `Pair`, `'key'` or `'value'`, correspondingly.
-*     `null` for the root node.
-*   - `node`: The current node.
-*   - `path`: The ancestry of the current node.
-*
-* The return value of the visitor may be used to control the traversal:
-*   - `Promise`: Must resolve to one of the following values
-*   - `undefined` (default): Do nothing and continue
-*   - `visitAsync.SKIP`: Do not visit the children of this node,
-*     continue with next sibling
-*   - `visitAsync.BREAK`: Terminate traversal completely
-*   - `visitAsync.REMOVE`: Remove the current node,
-*     then continue with the next one
-*   - `Node`: Replace the current node, then continue by visiting it
-*   - `number`: While iterating the items of a sequence or map, set the index
-*     of the next step. This is useful especially if the index of the current
-*     node has changed.
-*
-* If `visitor` is a single function, it will be called with all values
-* encountered in the tree, including e.g. `null` values. Alternatively,
-* separate visitor functions may be defined for each `Map`, `Pair`, `Seq`,
-* `Alias` and `Scalar` node. To define the same visitor function for more than
-* one node type, use the `Collection` (map and seq), `Value` (map, seq & scalar)
-* and `Node` (alias, map, seq & scalar) targets. Of all these, only the most
-* specific defined one will be used for each node.
-*/
+ * Apply an async visitor to an AST node or document.
+ *
+ * Walks through the tree (depth-first) starting from `node`, calling a
+ * `visitor` function with three arguments:
+ *   - `key`: For sequence values and map `Pair`, the node's index in the
+ *     collection. Within a `Pair`, `'key'` or `'value'`, correspondingly.
+ *     `null` for the root node.
+ *   - `node`: The current node.
+ *   - `path`: The ancestry of the current node.
+ *
+ * The return value of the visitor may be used to control the traversal:
+ *   - `Promise`: Must resolve to one of the following values
+ *   - `undefined` (default): Do nothing and continue
+ *   - `visitAsync.SKIP`: Do not visit the children of this node,
+ *     continue with next sibling
+ *   - `visitAsync.BREAK`: Terminate traversal completely
+ *   - `visitAsync.REMOVE`: Remove the current node,
+ *     then continue with the next one
+ *   - `Node`: Replace the current node, then continue by visiting it
+ *   - `number`: While iterating the items of a sequence or map, set the index
+ *     of the next step. This is useful especially if the index of the current
+ *     node has changed.
+ *
+ * If `visitor` is a single function, it will be called with all values
+ * encountered in the tree, including e.g. `null` values. Alternatively,
+ * separate visitor functions may be defined for each `Map`, `Pair`, `Seq`,
+ * `Alias` and `Scalar` node. To define the same visitor function for more than
+ * one node type, use the `Collection` (map and seq), `Value` (map, seq & scalar)
+ * and `Node` (alias, map, seq & scalar) targets. Of all these, only the most
+ * specific defined one will be used for each node.
+ */
 declare const visitAsync: {
-  (node: Node | Document | null, visitor: asyncVisitor): Promise<void>; /** Terminate visit traversal completely */
-  BREAK: symbol; /** Do not visit the children of the current node */
-  SKIP: symbol; /** Remove the current node */
+  (node: Node | Document | null, visitor: asyncVisitor): Promise<void>;
+  /** Terminate visit traversal completely */
+  BREAK: symbol;
+  /** Do not visit the children of the current node */
+  SKIP: symbol;
+  /** Remove the current node */
   REMOVE: symbol;
 };
 //#endregion

package/dist/index.js

@@ -1,4 +1,4 @@
-import { S as Scalar, a as Schema, d as Pair, f as isCollection, g as YAMLMap, h as YAMLSeq, i as Document, m as YAMLSet, n as visit, p as isNode, r as visitAsync, u as Alias } from "./directives-CiM56lHW.js";
-import { a as cst_exports, c as YAMLParseError, i as lex, l as YAMLWarning, n as Composer, r as Parser, s as YAMLError, t as LineCounter } from "./line-counter-bmCJ4fGy.js";
-import { i as stringify, n as parseAllDocuments, r as parseDocument, t as parse } from "./public-api-BTMehGT6.js";
+import { S as Scalar, _ as YAMLMap, a as Schema, f as Pair, g as YAMLSeq, h as YAMLSet, i as Document, m as isNode, n as visit, p as isCollection, r as visitAsync, u as Alias } from "./directives-DqP9ea45.js";
+import { a as cst_exports, c as YAMLParseError, i as lex, l as YAMLWarning, n as Composer, r as Parser, s as YAMLError, t as LineCounter } from "./line-counter-B2FjSv3E.js";
+import { i as stringify, n as parseAllDocuments, r as parseDocument, t as parse } from "./public-api-uicovB0N.js";
 export { Alias, cst_exports as CST, Composer, Document, LineCounter, Pair, Parser, Scalar, Schema, YAMLError, YAMLMap, YAMLParseError, YAMLSeq, YAMLSet, YAMLWarning, isCollection, isNode, lex, parse, parseAllDocuments, parseDocument, stringify, visit, visitAsync };