Skip to content

YAMLHelper

YAMLHelper provides helper methods for working with decoded YAML values.

new YAMLHelper(): YAMLHelper

YAMLHelper

isBool(value): value is boolean

isBool returns true if the YAML value is a boolean.

unknown

value is boolean


isDouble(value): value is number

isDouble returns true if the YAML value is a non-integer number.

unknown

value is number


isInteger(value): value is number

isInteger returns true if the YAML value is an integer.

unknown

value is number


isList(value): value is unknown[]

isList returns true if the YAML value is a list.

unknown

value is unknown[]


isMap(value): value is Record<string, unknown>

isMap returns true if the YAML value is a mapping.

unknown

value is Record<string, unknown>


isNull(value): value is null

isNull returns true if the YAML value is null.

unknown

value is null


isNumber(value): value is number

isNumber returns true if the YAML value is a finite number.

unknown

value is number


isString(value): value is string

isString returns true if the YAML value is a string.

unknown

value is string


isTimestamp(value): value is Date

isTimestamp returns true if the YAML value is a timestamp.

unknown

value is Date


rangeList(value, visitor): void

rangeList iterates over a list until the visitor returns false.

unknown

ListVisitor

void


rangeMap(value, visitor): void

rangeMap iterates over a mapping until the visitor returns false.

unknown

MapVisitor

void