The nodes supported by the serializer. Using an unsupported node will cause the serializer to throw.
Computes the similarity score between 2 Arrays, based on their contents.
Computes the similarity score between 2 Collections (e.g. YAMLMap, YAMLSeq), based on their items.
Computes the similarity score between 2 Pairs, based on their keys and values. If the keys aren't equal, we don't consider the Pairs as being similar.
Computes the similarity score between 2 Scalars, based on their values.
Computes the similarity score between 2 values.
Stringifies a JavaScript value into the corresponding YAML string.
Uses the core
schema by default.
The JavaScript value to dump.
The DumpOptions
that affect how the value is serialized.
The original YAML string. If set, this function will preserve all comments and styling from the original source.
Parses a YAML string into the corresponding JavaScript value.
Uses the core
schema by default.
The YAML source to load.
The LoadOptions
that affect how the value is deserialized.
Creates an updater given a data structure and the original node.
Pairs all updated items with an original item or null, based on a similarity score system.
Preserves the ordering of the original collection node.
If an item from the updated node is missing in the original node, it will be moved to the end of the resulting node.
Serializes (stringifies) a JavaScript value into the corresponding YAML string.
Uses the failsafe
schema.
The JavaScript value to dump.
The DumpOptions
that affect how the value is serialized.
The original YAML string. If set, this function will preserve all comments and styling from the original source.
Parses a YAML string into the corresponding JavaScript value.
Uses the failsafe
schema.
The YAML source to load.
The LoadOptions
that affect how the value is deserialized.
Updates a Map's items and sorts them:
preserveOriginalOrdering
option is setsortMapEntries
option if setUpdates a Pair's key and value.
Updates a Scalar's value.
Updates a sequence's items by pairing each updated item with a corresponding original item based on a computed similarity score.
It also preserves the original ordering if the preserveOriginalOrdering
option is set.
Updates a supported value.
Generated using TypeDoc
A number between 0 and 1.
Used to pick the most similar value in a list to a given value.