update deps
This commit is contained in:
142
node_modules/symbol-tree/README.md
generated
vendored
142
node_modules/symbol-tree/README.md
generated
vendored
@@ -55,6 +55,8 @@ tree.prependChild(grandparent, parent);
|
||||
console.log(tree.firstChild(tree.firstChild(grandparent)) === a);
|
||||
```
|
||||
|
||||
See [api.md](api.md) for more documentation.
|
||||
|
||||
Testing
|
||||
-------
|
||||
Make sure you install the dependencies first:
|
||||
@@ -72,7 +74,7 @@ API Documentation
|
||||
<a name="module_symbol-tree"></a>
|
||||
|
||||
## symbol-tree
|
||||
**Author:** Joris van der Wel <joris@jorisvanderwel.com>
|
||||
**Author**: Joris van der Wel <joris@jorisvanderwel.com>
|
||||
|
||||
* [symbol-tree](#module_symbol-tree)
|
||||
* [SymbolTree](#exp_module_symbol-tree--SymbolTree) ⏏
|
||||
@@ -107,7 +109,7 @@ API Documentation
|
||||
<a name="exp_module_symbol-tree--SymbolTree"></a>
|
||||
|
||||
### SymbolTree ⏏
|
||||
**Kind**: Exported class
|
||||
**Kind**: Exported class
|
||||
<a name="new_module_symbol-tree--SymbolTree_new"></a>
|
||||
|
||||
#### new SymbolTree([description])
|
||||
@@ -125,12 +127,12 @@ freeze your object.
|
||||
|
||||
`O(1)`
|
||||
|
||||
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
|
||||
**Returns**: <code>Object</code> - object
|
||||
**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree)
|
||||
**Returns**: <code>Object</code> - object
|
||||
|
||||
| Param | Type |
|
||||
| --- | --- |
|
||||
| object | <code>Object</code> |
|
||||
| object | <code>Object</code> |
|
||||
|
||||
<a name="module_symbol-tree--SymbolTree+hasChildren"></a>
|
||||
|
||||
@@ -139,11 +141,11 @@ Returns `true` if the object has any children. Otherwise it returns `false`.
|
||||
|
||||
* `O(1)`
|
||||
|
||||
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
|
||||
**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree)
|
||||
|
||||
| Param | Type |
|
||||
| --- | --- |
|
||||
| object | <code>Object</code> |
|
||||
| object | <code>Object</code> |
|
||||
|
||||
<a name="module_symbol-tree--SymbolTree+firstChild"></a>
|
||||
|
||||
@@ -152,11 +154,11 @@ Returns the first child of the given object.
|
||||
|
||||
* `O(1)`
|
||||
|
||||
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
|
||||
**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree)
|
||||
|
||||
| Param | Type |
|
||||
| --- | --- |
|
||||
| object | <code>Object</code> |
|
||||
| object | <code>Object</code> |
|
||||
|
||||
<a name="module_symbol-tree--SymbolTree+lastChild"></a>
|
||||
|
||||
@@ -165,11 +167,11 @@ Returns the last child of the given object.
|
||||
|
||||
* `O(1)`
|
||||
|
||||
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
|
||||
**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree)
|
||||
|
||||
| Param | Type |
|
||||
| --- | --- |
|
||||
| object | <code>Object</code> |
|
||||
| object | <code>Object</code> |
|
||||
|
||||
<a name="module_symbol-tree--SymbolTree+previousSibling"></a>
|
||||
|
||||
@@ -178,11 +180,11 @@ Returns the previous sibling of the given object.
|
||||
|
||||
* `O(1)`
|
||||
|
||||
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
|
||||
**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree)
|
||||
|
||||
| Param | Type |
|
||||
| --- | --- |
|
||||
| object | <code>Object</code> |
|
||||
| object | <code>Object</code> |
|
||||
|
||||
<a name="module_symbol-tree--SymbolTree+nextSibling"></a>
|
||||
|
||||
@@ -191,11 +193,11 @@ Returns the next sibling of the given object.
|
||||
|
||||
* `O(1)`
|
||||
|
||||
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
|
||||
**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree)
|
||||
|
||||
| Param | Type |
|
||||
| --- | --- |
|
||||
| object | <code>Object</code> |
|
||||
| object | <code>Object</code> |
|
||||
|
||||
<a name="module_symbol-tree--SymbolTree+parent"></a>
|
||||
|
||||
@@ -204,11 +206,11 @@ Return the parent of the given object.
|
||||
|
||||
* `O(1)`
|
||||
|
||||
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
|
||||
**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree)
|
||||
|
||||
| Param | Type |
|
||||
| --- | --- |
|
||||
| object | <code>Object</code> |
|
||||
| object | <code>Object</code> |
|
||||
|
||||
<a name="module_symbol-tree--SymbolTree+lastInclusiveDescendant"></a>
|
||||
|
||||
@@ -217,11 +219,11 @@ Find the inclusive descendant that is last in tree order of the given object.
|
||||
|
||||
* `O(n)` (worst case) where `n` is the depth of the subtree of `object`
|
||||
|
||||
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
|
||||
**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree)
|
||||
|
||||
| Param | Type |
|
||||
| --- | --- |
|
||||
| object | <code>Object</code> |
|
||||
| object | <code>Object</code> |
|
||||
|
||||
<a name="module_symbol-tree--SymbolTree+preceding"></a>
|
||||
|
||||
@@ -233,7 +235,7 @@ and A comes before B in tree order.
|
||||
* `O(n)` (worst case)
|
||||
* `O(1)` (amortized when walking the entire tree)
|
||||
|
||||
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
|
||||
**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree)
|
||||
|
||||
| Param | Type | Description |
|
||||
| --- | --- | --- |
|
||||
@@ -251,7 +253,7 @@ and A comes after B in tree order.
|
||||
* `O(n)` (worst case) where `n` is the amount of objects in the entire tree
|
||||
* `O(1)` (amortized when walking the entire tree)
|
||||
|
||||
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
|
||||
**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree)
|
||||
|
||||
| Param | Type | Default | Description |
|
||||
| --- | --- | --- | --- |
|
||||
@@ -267,7 +269,7 @@ Append all children of the given object to an array.
|
||||
|
||||
* `O(n)` where `n` is the amount of children of the given `parent`
|
||||
|
||||
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
|
||||
**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree)
|
||||
|
||||
| Param | Type | Default | Description |
|
||||
| --- | --- | --- | --- |
|
||||
@@ -284,7 +286,7 @@ Append all inclusive ancestors of the given object to an array.
|
||||
|
||||
* `O(n)` where `n` is the amount of ancestors of the given `object`
|
||||
|
||||
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
|
||||
**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree)
|
||||
|
||||
| Param | Type | Default | Description |
|
||||
| --- | --- | --- | --- |
|
||||
@@ -301,7 +303,7 @@ Append all descendants of the given object to an array (in tree order).
|
||||
|
||||
* `O(n)` where `n` is the amount of objects in the sub-tree of the given `object`
|
||||
|
||||
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
|
||||
**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree)
|
||||
|
||||
| Param | Type | Default | Description |
|
||||
| --- | --- | --- | --- |
|
||||
@@ -318,14 +320,14 @@ Iterate over all children of the given object
|
||||
|
||||
* `O(1)` for a single iteration
|
||||
|
||||
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
|
||||
**Returns**: <code>Object</code> - An iterable iterator (ES6)
|
||||
**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree)
|
||||
**Returns**: <code>Object</code> - An iterable iterator (ES6)
|
||||
|
||||
| Param | Type | Default |
|
||||
| --- | --- | --- |
|
||||
| parent | <code>Object</code> | |
|
||||
| [options] | <code>Object</code> | |
|
||||
| [options.reverse] | <code>Boolean</code> | <code>false</code> |
|
||||
| parent | <code>Object</code> | |
|
||||
| [options] | <code>Object</code> | |
|
||||
| [options.reverse] | <code>Boolean</code> | <code>false</code> |
|
||||
|
||||
<a name="module_symbol-tree--SymbolTree+previousSiblingsIterator"></a>
|
||||
|
||||
@@ -334,12 +336,12 @@ Iterate over all the previous siblings of the given object. (in reverse tree ord
|
||||
|
||||
* `O(1)` for a single iteration
|
||||
|
||||
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
|
||||
**Returns**: <code>Object</code> - An iterable iterator (ES6)
|
||||
**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree)
|
||||
**Returns**: <code>Object</code> - An iterable iterator (ES6)
|
||||
|
||||
| Param | Type |
|
||||
| --- | --- |
|
||||
| object | <code>Object</code> |
|
||||
| object | <code>Object</code> |
|
||||
|
||||
<a name="module_symbol-tree--SymbolTree+nextSiblingsIterator"></a>
|
||||
|
||||
@@ -348,12 +350,12 @@ Iterate over all the next siblings of the given object. (in tree order)
|
||||
|
||||
* `O(1)` for a single iteration
|
||||
|
||||
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
|
||||
**Returns**: <code>Object</code> - An iterable iterator (ES6)
|
||||
**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree)
|
||||
**Returns**: <code>Object</code> - An iterable iterator (ES6)
|
||||
|
||||
| Param | Type |
|
||||
| --- | --- |
|
||||
| object | <code>Object</code> |
|
||||
| object | <code>Object</code> |
|
||||
|
||||
<a name="module_symbol-tree--SymbolTree+ancestorsIterator"></a>
|
||||
|
||||
@@ -362,12 +364,12 @@ Iterate over all inclusive ancestors of the given object
|
||||
|
||||
* `O(1)` for a single iteration
|
||||
|
||||
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
|
||||
**Returns**: <code>Object</code> - An iterable iterator (ES6)
|
||||
**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree)
|
||||
**Returns**: <code>Object</code> - An iterable iterator (ES6)
|
||||
|
||||
| Param | Type |
|
||||
| --- | --- |
|
||||
| object | <code>Object</code> |
|
||||
| object | <code>Object</code> |
|
||||
|
||||
<a name="module_symbol-tree--SymbolTree+treeIterator"></a>
|
||||
|
||||
@@ -379,14 +381,14 @@ Where `n` is the amount of objects in the sub-tree of the given `root`:
|
||||
* `O(n)` (worst case for a single iteration)
|
||||
* `O(n)` (amortized, when completing the iterator)
|
||||
|
||||
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
|
||||
**Returns**: <code>Object</code> - An iterable iterator (ES6)
|
||||
**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree)
|
||||
**Returns**: <code>Object</code> - An iterable iterator (ES6)
|
||||
|
||||
| Param | Type | Default |
|
||||
| --- | --- | --- |
|
||||
| root | <code>Object</code> | |
|
||||
| options | <code>Object</code> | |
|
||||
| [options.reverse] | <code>Boolean</code> | <code>false</code> |
|
||||
| root | <code>Object</code> | |
|
||||
| options | <code>Object</code> | |
|
||||
| [options.reverse] | <code>Boolean</code> | <code>false</code> |
|
||||
|
||||
<a name="module_symbol-tree--SymbolTree+index"></a>
|
||||
|
||||
@@ -396,12 +398,12 @@ Find the index of the given object (the number of preceding siblings).
|
||||
* `O(n)` where `n` is the amount of preceding siblings
|
||||
* `O(1)` (amortized, if the tree is not modified)
|
||||
|
||||
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
|
||||
**Returns**: <code>Number</code> - The number of preceding siblings, or -1 if the object has no parent
|
||||
**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree)
|
||||
**Returns**: <code>Number</code> - The number of preceding siblings, or -1 if the object has no parent
|
||||
|
||||
| Param | Type |
|
||||
| --- | --- |
|
||||
| child | <code>Object</code> |
|
||||
| child | <code>Object</code> |
|
||||
|
||||
<a name="module_symbol-tree--SymbolTree+childrenCount"></a>
|
||||
|
||||
@@ -411,11 +413,11 @@ Calculate the number of children.
|
||||
* `O(n)` where `n` is the amount of children
|
||||
* `O(1)` (amortized, if the tree is not modified)
|
||||
|
||||
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
|
||||
**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree)
|
||||
|
||||
| Param | Type |
|
||||
| --- | --- |
|
||||
| parent | <code>Object</code> |
|
||||
| parent | <code>Object</code> |
|
||||
|
||||
<a name="module_symbol-tree--SymbolTree+compareTreePosition"></a>
|
||||
|
||||
@@ -439,12 +441,12 @@ where `o` is the amount of children of the lowest common ancestor of `left` and
|
||||
* `O(n + m + o)` (worst case)
|
||||
* `O(n + m)` (amortized, if the tree is not modified)
|
||||
|
||||
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
|
||||
**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree)
|
||||
|
||||
| Param | Type |
|
||||
| --- | --- |
|
||||
| left | <code>Object</code> |
|
||||
| right | <code>Object</code> |
|
||||
| left | <code>Object</code> |
|
||||
| right | <code>Object</code> |
|
||||
|
||||
<a name="module_symbol-tree--SymbolTree+remove"></a>
|
||||
|
||||
@@ -454,12 +456,12 @@ Has no effect if already removed.
|
||||
|
||||
* `O(1)`
|
||||
|
||||
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
|
||||
**Returns**: <code>Object</code> - removeObject
|
||||
**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree)
|
||||
**Returns**: <code>Object</code> - removeObject
|
||||
|
||||
| Param | Type |
|
||||
| --- | --- |
|
||||
| removeObject | <code>Object</code> |
|
||||
| removeObject | <code>Object</code> |
|
||||
|
||||
<a name="module_symbol-tree--SymbolTree+insertBefore"></a>
|
||||
|
||||
@@ -469,8 +471,8 @@ Insert the given object before the reference object.
|
||||
|
||||
* `O(1)`
|
||||
|
||||
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
|
||||
**Returns**: <code>Object</code> - newObject
|
||||
**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree)
|
||||
**Returns**: <code>Object</code> - newObject
|
||||
**Throws**:
|
||||
|
||||
- <code>Error</code> If the newObject is already present in this SymbolTree
|
||||
@@ -478,8 +480,8 @@ Insert the given object before the reference object.
|
||||
|
||||
| Param | Type |
|
||||
| --- | --- |
|
||||
| referenceObject | <code>Object</code> |
|
||||
| newObject | <code>Object</code> |
|
||||
| referenceObject | <code>Object</code> |
|
||||
| newObject | <code>Object</code> |
|
||||
|
||||
<a name="module_symbol-tree--SymbolTree+insertAfter"></a>
|
||||
|
||||
@@ -489,8 +491,8 @@ Insert the given object after the reference object.
|
||||
|
||||
* `O(1)`
|
||||
|
||||
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
|
||||
**Returns**: <code>Object</code> - newObject
|
||||
**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree)
|
||||
**Returns**: <code>Object</code> - newObject
|
||||
**Throws**:
|
||||
|
||||
- <code>Error</code> If the newObject is already present in this SymbolTree
|
||||
@@ -498,8 +500,8 @@ Insert the given object after the reference object.
|
||||
|
||||
| Param | Type |
|
||||
| --- | --- |
|
||||
| referenceObject | <code>Object</code> |
|
||||
| newObject | <code>Object</code> |
|
||||
| referenceObject | <code>Object</code> |
|
||||
| newObject | <code>Object</code> |
|
||||
|
||||
<a name="module_symbol-tree--SymbolTree+prependChild"></a>
|
||||
|
||||
@@ -509,8 +511,8 @@ Insert the given object as the first child of the given reference object.
|
||||
|
||||
* `O(1)`
|
||||
|
||||
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
|
||||
**Returns**: <code>Object</code> - newObject
|
||||
**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree)
|
||||
**Returns**: <code>Object</code> - newObject
|
||||
**Throws**:
|
||||
|
||||
- <code>Error</code> If the newObject is already present in this SymbolTree
|
||||
@@ -518,8 +520,8 @@ Insert the given object as the first child of the given reference object.
|
||||
|
||||
| Param | Type |
|
||||
| --- | --- |
|
||||
| referenceObject | <code>Object</code> |
|
||||
| newObject | <code>Object</code> |
|
||||
| referenceObject | <code>Object</code> |
|
||||
| newObject | <code>Object</code> |
|
||||
|
||||
<a name="module_symbol-tree--SymbolTree+appendChild"></a>
|
||||
|
||||
@@ -529,8 +531,8 @@ Insert the given object as the last child of the given reference object.
|
||||
|
||||
* `O(1)`
|
||||
|
||||
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
|
||||
**Returns**: <code>Object</code> - newObject
|
||||
**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree)
|
||||
**Returns**: <code>Object</code> - newObject
|
||||
**Throws**:
|
||||
|
||||
- <code>Error</code> If the newObject is already present in this SymbolTree
|
||||
@@ -538,6 +540,6 @@ Insert the given object as the last child of the given reference object.
|
||||
|
||||
| Param | Type |
|
||||
| --- | --- |
|
||||
| referenceObject | <code>Object</code> |
|
||||
| newObject | <code>Object</code> |
|
||||
| referenceObject | <code>Object</code> |
|
||||
| newObject | <code>Object</code> |
|
||||
|
||||
|
Reference in New Issue
Block a user