Skip to content

Commit 47308cf

Browse files
regenerate documentation
1 parent 83ff16d commit 47308cf

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

api.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
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>
2121
* [.childrenIterator(parent)](#module_symbol-tree--SymbolTree+childrenIterator) ⇒ <code>Object</code>
22+
* [.prevSiblingsIterator(object)](#module_symbol-tree--SymbolTree+prevSiblingsIterator) ⇒ <code>Object</code>
23+
* [.nextSiblingsIterator(object)](#module_symbol-tree--SymbolTree+nextSiblingsIterator) ⇒ <code>Object</code>
2224
* [.ancestorsIterator(object)](#module_symbol-tree--SymbolTree+ancestorsIterator) ⇒ <code>Object</code>
2325
* [.treeIterator(root)](#module_symbol-tree--SymbolTree+treeIterator) ⇒ <code>Object</code>
2426
* [.index(child)](#module_symbol-tree--SymbolTree+index) ⇒ <code>Number</code>
@@ -217,7 +219,7 @@ Append all descendants of the given object to an array (in tree order).
217219

218220
<a name="module_symbol-tree--SymbolTree+childrenIterator"></a>
219221
#### symbolTree.childrenIterator(parent) ⇒ <code>Object</code>
220-
Iterate over all children of the given object to an array.
222+
Iterate over all children of the given object
221223

222224
`O(1)` for a single iteration
223225

@@ -228,6 +230,32 @@ Iterate over all children of the given object to an array.
228230
| --- | --- |
229231
| parent | <code>Object</code> |
230232

233+
<a name="module_symbol-tree--SymbolTree+prevSiblingsIterator"></a>
234+
#### symbolTree.prevSiblingsIterator(object) ⇒ <code>Object</code>
235+
Iterate over all the previous siblings of the given object. (in reverse tree order)
236+
237+
`O(1)` for a single iteration
238+
239+
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
240+
**Returns**: <code>Object</code> - An iterable iterator (ES6)
241+
242+
| Param | Type |
243+
| --- | --- |
244+
| object | <code>Object</code> |
245+
246+
<a name="module_symbol-tree--SymbolTree+nextSiblingsIterator"></a>
247+
#### symbolTree.nextSiblingsIterator(object) ⇒ <code>Object</code>
248+
Iterate over all the next siblings of the given object. (in tree order)
249+
250+
`O(1)` for a single iteration
251+
252+
**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
253+
**Returns**: <code>Object</code> - An iterable iterator (ES6)
254+
255+
| Param | Type |
256+
| --- | --- |
257+
| object | <code>Object</code> |
258+
231259
<a name="module_symbol-tree--SymbolTree+ancestorsIterator"></a>
232260
#### symbolTree.ancestorsIterator(object) ⇒ <code>Object</code>
233261
Iterate over all inclusive ancestors of the given object

0 commit comments

Comments
 (0)