Skip to content

Commit 6629d9a

Browse files
regenerate documentation
1 parent dcf1b05 commit 6629d9a

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

api.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818
* [.childrenToArray(parent, [array], [filter], [thisArg])](#module_symbol-tree--SymbolTree+childrenToArray) ⇒ <code>Array.&lt;Object&gt;</code>
1919
* [.ancestorsToArray(object, [array], [filter], [thisArg])](#module_symbol-tree--SymbolTree+ancestorsToArray) ⇒ <code>Array.&lt;Object&gt;</code>
2020
* [.treeToArray(root, [array], [filter], [thisArg])](#module_symbol-tree--SymbolTree+treeToArray) ⇒ <code>Array.&lt;Object&gt;</code>
21-
* [.childrenIterator(parent)](#module_symbol-tree--SymbolTree+childrenIterator) ⇒ <code>Object</code>
21+
* [.childrenIterator(parent, [reverse])](#module_symbol-tree--SymbolTree+childrenIterator) ⇒ <code>Object</code>
2222
* [.prevSiblingsIterator(object)](#module_symbol-tree--SymbolTree+prevSiblingsIterator) ⇒ <code>Object</code>
2323
* [.nextSiblingsIterator(object)](#module_symbol-tree--SymbolTree+nextSiblingsIterator) ⇒ <code>Object</code>
2424
* [.ancestorsIterator(object)](#module_symbol-tree--SymbolTree+ancestorsIterator) ⇒ <code>Object</code>
25-
* [.treeIterator(root)](#module_symbol-tree--SymbolTree+treeIterator) ⇒ <code>Object</code>
25+
* [.treeIterator(root, [reverse])](#module_symbol-tree--SymbolTree+treeIterator) ⇒ <code>Object</code>
2626
* [.index(child)](#module_symbol-tree--SymbolTree+index) ⇒ <code>Number</code>
2727
* [.childrenCount(parent)](#module_symbol-tree--SymbolTree+childrenCount) ⇒ <code>Number</code>
2828
* [.compareTreePosition(left, right)](#module_symbol-tree--SymbolTree+compareTreePosition) ⇒ <code>Number</code>
@@ -218,17 +218,18 @@ Append all descendants of the given object to an array (in tree order).
218218
| [thisArg] | <code>\*</code> | | Value to use as `this` when executing `filter`. |
219219

220220
<a name="module_symbol-tree--SymbolTree+childrenIterator"></a>
221-
#### symbolTree.childrenIterator(parent) ⇒ <code>Object</code>
221+
#### symbolTree.childrenIterator(parent, [reverse]) ⇒ <code>Object</code>
222222
Iterate over all children of the given object
223223

224224
`O(1)` for a single iteration
225225

226226
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
227227
**Returns**: <code>Object</code> - An iterable iterator (ES6)
228228

229-
| Param | Type |
230-
| --- | --- |
231-
| parent | <code>Object</code> |
229+
| Param | Type | Default |
230+
| --- | --- | --- |
231+
| parent | <code>Object</code> | |
232+
| [reverse] | <code>Boolean</code> | <code>false</code> |
232233

233234
<a name="module_symbol-tree--SymbolTree+prevSiblingsIterator"></a>
234235
#### symbolTree.prevSiblingsIterator(object) ⇒ <code>Object</code>
@@ -270,7 +271,7 @@ Iterate over all inclusive ancestors of the given object
270271
| object | <code>Object</code> |
271272

272273
<a name="module_symbol-tree--SymbolTree+treeIterator"></a>
273-
#### symbolTree.treeIterator(root) ⇒ <code>Object</code>
274+
#### symbolTree.treeIterator(root, [reverse]) ⇒ <code>Object</code>
274275
Iterate over all descendants of the given object (in tree order).
275276

276277
`O(n)` for the entire iteration<br>
@@ -279,9 +280,10 @@ Iterate over all descendants of the given object (in tree order).
279280
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
280281
**Returns**: <code>Object</code> - An iterable iterator (ES6)
281282

282-
| Param | Type |
283-
| --- | --- |
284-
| root | <code>Object</code> |
283+
| Param | Type | Default |
284+
| --- | --- | --- |
285+
| root | <code>Object</code> | |
286+
| [reverse] | <code>Boolean</code> | <code>false</code> |
285287

286288
<a name="module_symbol-tree--SymbolTree+index"></a>
287289
#### symbolTree.index(child) ⇒ <code>Number</code>

0 commit comments

Comments
 (0)