Upgrading js-yaml from 4.x to 5.x

Comparison of the public API of js-yaml 4.3.2 and 5.4.2, computed automatically from their TypeScript types. A changed signature is a candidate for a breaking change, not a certainty.

Summary

Removed import paths	0
Removed exports	7
Changed signatures	3
Removed class or interface members	9
Changed class or interface members	3
Newly deprecated	2
Requirement changes (engines, peer dependencies)	0
New exports	94

Removed exports

import	export	kind	Before
`js-yaml`	`Mark`	interface	`interface`
`js-yaml`	`Type`	class	`class`
`js-yaml`	`State`	interface	`interface`
`js-yaml`	`EventType`	type	`"open" \| "close"`
`js-yaml`	`DEFAULT_SCHEMA`	variable	`Schema`
`js-yaml`	`SchemaDefinition`	interface	`interface`
`js-yaml`	`TypeConstructorOptions`	interface	`interface`

Changed signatures

export	Before	After
`js-yaml · dump`	`(obj: any, opts?: DumpOptions \| undefined): string`	`(input: any, options?: DumpOptions \| undefined): string`
`js-yaml · load`	`(str: string, opts?: LoadOptions \| undefined): unknown`	`(input: string, options?: LoadOptions \| undefined): unknown`
`js-yaml · loadAll`	`(str: string, iterator?: null \| undefined, opts?: LoadOptions \| undefined): unknown[] \| (str: string, iterator: (doc: unknown) => void, opts?: LoadOptions \| undefined): void`	`(input: string, options?: LoadOptions \| undefined): unknown[] \| (input: string, iterator: null, options?: LoadOptions \| undefined): unknown[] \| (input: string, iterator: LoadAllIterator, options?: LoadOptions \| undefined): void`

Removed class or interface members

member	import	Before
`Schema.extend`	`js-yaml`	`(types: Type \| SchemaDefinition \| Type[]): Schema`
`DumpOptions.styles`	`js-yaml`	`{ [x: string]: any; } \| undefined`
`DumpOptions.replacer`	`js-yaml`	`((key: string, value: any) => any) \| undefined`
`DumpOptions.quotingType`	`js-yaml`	`"'" \| "\"" \| undefined`
`DumpOptions.condenseFlow`	`js-yaml`	`boolean \| undefined`
`DumpOptions.noCompatMode`	`js-yaml`	`boolean \| undefined`
`DumpOptions.noArrayIndent`	`js-yaml`	`boolean \| undefined`
`LoadOptions.listener`	`js-yaml`	`((this: State, eventType: EventType, state: State) => void) \| undefined`
`LoadOptions.onWarning`	`js-yaml`	`((this: null, e: YAMLException) => void) \| undefined`

Changed class or interface members

member	Before	After
`Schema.constructor`	`(definition: Type \| SchemaDefinition \| Type[]): Schema`	`(tags: readonly TagDefinition[]): Schema`
`YAMLException.mark`	`Mark`	`SnippetMark \| undefined`
`YAMLException.constructor`	`(reason?: string \| undefined, mark?: Mark \| undefined): YAMLException`	`(reason: string, mark?: SnippetMark \| undefined): YAMLException`

Newly deprecated

export	@deprecated
`js-yaml · loadAll`	Iterator is not supported.
`js-yaml · DumpOptions.sortKeys`	Use {@link transform} to reorder mapping items.

Requirement changes (engines, peer dependencies)

None detected.

New exports (94)

import	export	kind
`js-yaml`	`Node`	type
`js-yaml`	`Event`	type
`js-yaml`	`visit`	function
`js-yaml`	`mapTag`	variable
`js-yaml`	`seqTag`	variable
`js-yaml`	`setTag`	variable
`js-yaml`	`strTag`	variable
`js-yaml`	`EventId`	type
`js-yaml`	`Visitor`	type
`js-yaml`	`jsToAst`	function
`js-yaml`	`omapTag`	variable
`js-yaml`	`present`	function
`js-yaml`	`Document`	interface
`js-yaml`	`EVENT_ID`	variable
`js-yaml`	`NodeBase`	interface
`js-yaml`	`PopEvent`	interface
`js-yaml`	`mergeTag`	variable
`js-yaml`	`pairsTag`	variable
`js-yaml`	`AliasNode`	interface
`js-yaml`	`EVENT_POP`	variable
`js-yaml`	`binaryTag`	variable
`js-yaml`	`AliasEvent`	interface
`js-yaml`	`ScalarNode`	interface
`js-yaml`	`VISIT_SKIP`	variable
`js-yaml`	`intCoreTag`	variable
`js-yaml`	`intJsonTag`	variable
`js-yaml`	`realMapTag`	variable
`js-yaml`	`DUMP_SCHEMA`	variable
`js-yaml`	`EVENT_ALIAS`	variable
`js-yaml`	`MappingNode`	interface
`js-yaml`	`ScalarEvent`	interface
`js-yaml`	`ScalarStyle`	type
`js-yaml`	`VISIT_BREAK`	variable
`js-yaml`	`boolCoreTag`	variable
`js-yaml`	`boolJsonTag`	variable
`js-yaml`	`eventsToAst`	function
`js-yaml`	`nullCoreTag`	variable
`js-yaml`	`nullJsonTag`	variable
`js-yaml`	`parseEvents`	function
`js-yaml`	`ChompingMode`	type
`js-yaml`	`EVENT_SCALAR`	variable
`js-yaml`	`MappingEvent`	interface
`js-yaml`	`NOT_RESOLVED`	variable
`js-yaml`	`SCALAR_STYLE`	variable
`js-yaml`	`ScalarLayout`	interface
`js-yaml`	`SequenceNode`	interface
`js-yaml`	`VisitContext`	interface
`js-yaml`	`floatCoreTag`	variable
`js-yaml`	`floatJsonTag`	variable
`js-yaml`	`intYaml11Tag`	variable
`js-yaml`	`legacyMapTag`	variable
`js-yaml`	`timestampTag`	variable
`js-yaml`	`CHOMPING_CLIP`	variable
`js-yaml`	`CHOMPING_KEEP`	variable
`js-yaml`	`CHOMPING_MODE`	variable
`js-yaml`	`DocumentEvent`	interface
`js-yaml`	`EVENT_MAPPING`	variable
`js-yaml`	`FromJsOptions`	interface
`js-yaml`	`ParserOptions`	interface
`js-yaml`	`SequenceEvent`	interface
`js-yaml`	`TagDefinition`	type
`js-yaml`	`YAML11_SCHEMA`	variable
`js-yaml`	`boolYaml11Tag`	variable
`js-yaml`	`nullYaml11Tag`	variable
`js-yaml`	`CHOMPING_STRIP`	variable
`js-yaml`	`EVENT_DOCUMENT`	variable
`js-yaml`	`EVENT_SEQUENCE`	variable
`js-yaml`	`floatYaml11Tag`	variable
`js-yaml`	`getScalarValue`	function
`js-yaml`	`CollectionStyle`	type
`js-yaml`	`ScalarStyleRule`	type
`js-yaml`	`defineScalarTag`	function
`js-yaml`	`COLLECTION_STYLE`	variable
`js-yaml`	`PresenterOptions`	interface
`js-yaml`	`ScalarTagOptions`	interface
`js-yaml`	`defineMappingTag`	function
`js-yaml`	`DocumentDirective`	type
`js-yaml`	`FromEventsOptions`	interface
`js-yaml`	`MappingTagOptions`	interface
`js-yaml`	`defineSequenceTag`	function
`js-yaml`	`ConstructorOptions`	interface
`js-yaml`	`SCALAR_STYLE_PLAIN`	variable
`js-yaml`	`SequenceTagOptions`	interface
`js-yaml`	`ScalarTagDefinition`	interface
`js-yaml`	`constructFromEvents`	function
`js-yaml`	`MappingTagDefinition`	interface
`js-yaml`	`COLLECTION_STYLE_FLOW`	variable
`js-yaml`	`SequenceTagDefinition`	interface
`js-yaml`	`COLLECTION_STYLE_BLOCK`	variable
`js-yaml`	`SCALAR_STYLE_FOLDED_BLOCK`	variable
`js-yaml`	`DEFAULT_SCALAR_STYLE_RULES`	variable
`js-yaml`	`SCALAR_STYLE_DOUBLE_QUOTED`	variable
`js-yaml`	`SCALAR_STYLE_LITERAL_BLOCK`	variable
`js-yaml`	`SCALAR_STYLE_SINGLE_QUOTED`	variable

Frequently asked questions

What are the breaking changes when upgrading js-yaml from 4 to 5?

Between js-yaml 4.3.2 and 5.4.2, Vigia found 7 removed exports, 3 changed signatures and 12 removed or changed class or interface members.

What became deprecated in js-yaml 5?

2 exports or members are newly marked as deprecated in js-yaml 5.4.2.

For agents

GET https://vigia.coredls.cloud/v1/packages/npm/js-yaml/upgrade?from=4.3.2&to=5.4.2