Skip to content

Parsed

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Scalar.d.ts:7

The yaml node, tag and visitor model, re-exported so a caller can write a custom tag without taking its own dependency on yaml.

Names are Yaml-prefixed rather than kept as upstream. This package’s index is a flat export *, so a bare Node, Document, Scalar or Schema would sit beside YamlParseStream and parseYaml under names that say nothing about YAML — and Node and Document are DOM globals, which this package, being portable, is expected to be imported alongside.

readonly [NODE_TYPE]: symbol

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Node.d.ts:22

YamlScalar.[NODE_TYPE]


optional addToJSMap?: (ctx, map, value) => void

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Node.d.ts:44

Customize the way that a key-value pair is resolved. Used for YAML 1.1 !!merge << handling.

YamlToJsContext | undefined

MapLike

unknown

void

YamlScalar.addToJSMap


optional anchor?: string

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Scalar.d.ts:27

An optional anchor on this node. Used by alias nodes.

YamlScalar.anchor


optional comment?: string | null

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Node.d.ts:24

A comment on or immediately after this

Parsed.comment


optional commentBefore?: string | null

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Node.d.ts:26

A comment before this

Parsed.commentBefore


optional format?: string

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Scalar.d.ts:33

By default (undefined), numbers use decimal notation. The YAML 1.2 core schema only supports ‘HEX’ and ‘OCT’. The YAML 1.1 schema also supports ‘BIN’ and ‘TIME’

YamlScalar.format


optional minFractionDigits?: number

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Scalar.d.ts:39

If value is a number that is serialized as a decimal string (i.e. not using exponential notation), use this value when stringifying this node.

YamlScalar.minFractionDigits


range: YamlRange

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Scalar.d.ts:8

The [start, value-end, node-end] character offsets for the part of the source parsed into this node (undefined if not parsed). The value-end and node-end positions are themselves not included in their respective ranges.

YamlMap.range


source: string

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Scalar.d.ts:9

Set during parsing to the source string value

YamlScalar.source


optional spaceBefore?: boolean

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Node.d.ts:35

A blank line before this node and its commentBefore

YamlScalar.spaceBefore


optional srcToken?: FlowScalar | BlockScalar

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Scalar.d.ts:10

The CST token that was composed into this node.

YamlScalar.srcToken


optional tag?: string

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Node.d.ts:39

A fully qualified tag, if required

YamlScalar.tag


optional type?: Type

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Scalar.d.ts:43

The scalar style used for the node’s string representation

YamlScalar.type


value: unknown

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Scalar.d.ts:25

YamlScalar.value

clone(): NodeBase

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Node.d.ts:50

Create a copy of this node.

NodeBase

YamlScalar.clone


toJS(doc, __namedParameters?): any

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Node.d.ts:52

A plain JavaScript representation of this node.

YamlDocument<YamlNode<unknown>, boolean>

ToJSOptions

any

YamlScalar.toJS


toJSON(arg?, ctx?): any

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Scalar.d.ts:45

A plain JS representation of this node

any

YamlToJsContext

any

YamlScalar.toJSON


toString(): string

Defined in: node_modules/.store/yaml-npm-2.9.1-d61da744fe/package/dist/nodes/Scalar.d.ts:46

string

YamlScalar.toString