Directives | /node_modules/yaml/dist/doc/directives.d.ts | windmill@v1.426.1

class Directives

import { Directives } from "https://deno.land/x/windmill@v1.426.1/node_modules/yaml/dist/doc/directives.d.ts";

Constructors

new

Directives(yaml?: Directives["yaml"], tags?: Directives["tags"])

Properties

private

optional

atNextDocument

Used when parsing YAML 1.1, where:

If the document specifies no directives, it is parsed using the same settings as the previous document. If the document does specify any directives, all directives of previous documents, if any, are ignored.

docEnd: boolean

The doc-end marker ....

docStart: true | null

The directives-end/doc-start marker ---. If null, a marker may still be included in the document's stringified representation.

tags: Record<string, string>

yaml: { version: "1.1" | "1.2" | "next"; explicit?: boolean; }

Methods

add(line: string, onError: (

offset: number,

message: string,

warning?: boolean,

) => void): boolean

atDocument(): Directives

During parsing, get a Directives instance for the current document and update the stream state according to the current version's spec.

clone(): Directives

tagName(source: string, onError: (message: string) => void): string | null

Resolves a tag, matching handles to those defined in %TAG directives.

tagString(tag: string): string

Given a fully resolved tag, returns its printable string form, taking into account current tag prefixes and defaults.

toString(doc?: Document): string

Static Properties

defaultTags: Directives["tags"]

defaultYaml: Directives["yaml"]