hinted-tree-merger

merges two trees guided with hints

usage

merge array having entries identified by key

import { merge } from "hinted-tree-merger";

const r = merge(
        [{ k:1, e:1}, { k:2}],
        [{ k:1, e:2}, { k:3}], // 2nd. array has precedence
        "",
      undefined,
      {
        "": { key: "k" } // identify slots by property "k"
      });

  // r := [{ k:1 e:2 }, { k:2 }, { k:3 }]

deep copy

import { merge } from "hinted-tree-merger";

const r = merge( undefined, [ { k:1, e:2}, { k:3 }]);

  // r := [{ k:1 e:2 }, { k:2 }, { k:3 }]

API

Table of Contents

• hintFor
  • Parameters
• Actions
  • Parameters
• mergeSkip
  • Parameters
• mergeArrays
  • Parameters
• merge
  • Parameters
• hasDeleteHint
  • Parameters
• isToBeRemoved
  • Parameters
• hintFreeValue
  • Parameters
• indexFor
  • Parameters
• keyFor
  • Parameters
• sortObjectsByKeys
  • Parameters
• compareWithDefinedOrder
  • Parameters
• matchingIndex
  • Parameters
• match
• cmp
  • Parameters
• compareVersion
  • Parameters
• unionVersion
  • Parameters
• VersionMapper
• mergeVersionsWithFilter
  • Parameters
• mergeVersions
  • Parameters
• mergeVersionsPreferNumeric
  • Parameters
• walk
  • Parameters

hintFor

Construct hint for a given path.

Parameters

• hints Object
• path string

Actions

Type: Function

Parameters

• options Object
• hints Object

mergeSkip

Skip merging use left side always.

Parameters

• a
• b
• path
• actions
• hints

mergeArrays

Parameters

• a Array
• b Array
• path string
• actions Actions (optional, default nullAction)
• hints Object

merge

Merge to values.

Parameters

• a any
• b any
• path
• actions Actions (optional, default nullAction)
• hints any

Returns any merged value

hasDeleteHint

Parameters

• value any
• expected (string | Function)

Returns (string | boolean)

isToBeRemoved

Should value be removed.

Parameters

• value string
• fromTemplate string

Returns Object true if fromTemplate tells is to delete value

hintFreeValue

Remove hint(s) form a value.

Parameters

• value (string | any)

Returns any value without hint

indexFor

Find best insertion point for b[i] in a.

Parameters

• b Array<any>
• i number
• a Array<any>

keyFor

Deliver key value to identify object.

Parameters

• object any
• hint Object

Returns (string | undefined)

sortObjectsByKeys

Sort keys in source.

Parameters

• source Object
• compare

Returns Object source with keys orderd by compare function

compareWithDefinedOrder

Parameters

• a any
• b any
• definedOrder

matchingIndex

Parameters

• value any

Returns number

match

url means highest version

cmp

Parameters

• a Array<number>
• b Array<number>

Returns number

compareVersion

Compare two versions.

Parameters

• a (string | number)
• b (string | number)

Returns number -1 if a < b, 0 if a == b and 1 if a > b

unionVersion

Forms union of two versions.

Parameters

• a (string | number)
• b (string | number)

Returns (string | number)

VersionMapper

maps version values (to number)

Type: Function

mergeVersionsWithFilter

Merge and filter two sets of version (expressions).

Parameters

• a (string | Array<string> | number | Array<number>)
• b (string | Array<string> | number | Array<number>)
• path string location in the tree
• actions Function cb to notify about the actual selection (optional, default nullAction)
• hints Object
• filter VersionMapper

Returns (string | Array<string> | number | Array<number>) merged set of version expressions

mergeVersions

merge two sets of version (expressions)

Parameters

• a (string | Array<string> | number | Array<number>)
• b (string | Array<string> | number | Array<number>)
• path string location in the tree
• actions Function cb to notify about the actual selection
• hints Object

Returns (string | Array<string> | number | Array<number>) merged set of version expressions

mergeVersionsPreferNumeric

Same as mergeVersions but merge result are converted into numbers if possible

Parameters

• a (string | Array<string> | number | Array<number>)
• b (string | Array<string> | number | Array<number>)
• path string location in the tree
• actions Function cb to notify about the actual selection
• hints Object

Returns (string | Array<string> | number | Array<number>) merged set of version expressions

walk

Iterates over all members.

Parameters

• value any
• path Array<any> (optional, default [])
• parents (optional, default [])

install

With npm do:

npm install hinted-tree-merger

license

BSD-2-Clause