default
constdefault:object
Defined in: src/js-yaml-compat.ts:384
Type Declaration
Section titled “Type Declaration”CORE_SCHEMA
Section titled “CORE_SCHEMA”CORE_SCHEMA:
Schema
Stub — see FAILSAFE_SCHEMA.
defineMappingTag
Section titled “defineMappingTag”defineMappingTag: (
tagName,_opts) =>TagDefinition
Stub mirroring js-yaml v5’s defineMappingTag. Nothing reads the result yet.
Parameters
Section titled “Parameters”tagName
Section titled “tagName”string
_opts?
Section titled “_opts?”Record<string, unknown> = {}
Returns
Section titled “Returns”defineScalarTag
Section titled “defineScalarTag”defineScalarTag: (
tagName,_opts) =>TagDefinition
Stub mirroring js-yaml v5’s defineScalarTag. Nothing reads the result yet.
Parameters
Section titled “Parameters”tagName
Section titled “tagName”string
_opts?
Section titled “_opts?”Record<string, unknown> = {}
Returns
Section titled “Returns”defineSequenceTag
Section titled “defineSequenceTag”defineSequenceTag: (
tagName,_opts) =>TagDefinition
Stub mirroring js-yaml v5’s defineSequenceTag. Nothing reads the result yet.
Parameters
Section titled “Parameters”tagName
Section titled “tagName”string
_opts?
Section titled “_opts?”Record<string, unknown> = {}
Returns
Section titled “Returns”dump: (
obj,opts?) =>string
Delegates to our stringify; dump options are validated and throw until honoured.
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”string
FAILSAFE_SCHEMA
Section titled “FAILSAFE_SCHEMA”FAILSAFE_SCHEMA:
Schema
Stub so import { FAILSAFE_SCHEMA } still works. Our parser is fixed to YAML 1.2 core, so passing this as the schema option to load/dump throws (only the default CORE_SCHEMA is accepted).
JSON_SCHEMA
Section titled “JSON_SCHEMA”JSON_SCHEMA:
Schema
Stub — see FAILSAFE_SCHEMA.
load: (
input,opts?) =>unknown
Parse exactly one document; an empty stream or multiple documents throws.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”unknown
loadAll
Section titled “loadAll”loadAll: (
input,iteratorOrOpts?,opts?) =>unknown[] |undefined
Parameters
Section titled “Parameters”string
iteratorOrOpts?
Section titled “iteratorOrOpts?”LoadOptions | ((doc) => void) | null
Returns
Section titled “Returns”unknown[] | undefined
Schema
Section titled “Schema”Schema: typeof
Schema
YAML11_SCHEMA
Section titled “YAML11_SCHEMA”YAML11_SCHEMA:
Schema
Stub. Does NOT turn on YAML 1.1 typing; passing it as the schema option throws, because we always parse as YAML 1.2 core. See FAILSAFE_SCHEMA.
YAMLException
Section titled “YAMLException”YAMLException: typeof
YAMLException