Skip to content

Commit 8a3c5a4

Browse files
Update generated documentation
1 parent 9190990 commit 8a3c5a4

File tree

1 file changed

+62
-33
lines changed

1 file changed

+62
-33
lines changed

api.md

Lines changed: 62 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,52 @@
11
<a name="module_symbol-tree"></a>
2+
23
## symbol-tree
34
**Author:** Joris van der Wel <joris@jorisvanderwel.com>
45

56
* [symbol-tree](#module_symbol-tree)
6-
* [SymbolTree](#exp_module_symbol-tree--SymbolTree)
7-
* [new SymbolTree([description])](#new_module_symbol-tree--SymbolTree_new)
8-
* [.initialize(object)](#module_symbol-tree--SymbolTree+initialize) ⇒ <code>Object</code>
9-
* [.hasChildren(object)](#module_symbol-tree--SymbolTree+hasChildren) ⇒ <code>Boolean</code>
10-
* [.firstChild(object)](#module_symbol-tree--SymbolTree+firstChild) ⇒ <code>Object</code>
11-
* [.lastChild(object)](#module_symbol-tree--SymbolTree+lastChild) ⇒ <code>Object</code>
12-
* [.previousSibling(object)](#module_symbol-tree--SymbolTree+previousSibling) ⇒ <code>Object</code>
13-
* [.nextSibling(object)](#module_symbol-tree--SymbolTree+nextSibling) ⇒ <code>Object</code>
14-
* [.parent(object)](#module_symbol-tree--SymbolTree+parent) ⇒ <code>Object</code>
15-
* [.lastInclusiveDescendant(object)](#module_symbol-tree--SymbolTree+lastInclusiveDescendant) ⇒ <code>Object</code>
16-
* [.preceding(object, [options])](#module_symbol-tree--SymbolTree+preceding) ⇒ <code>Object</code>
17-
* [.following(object, [options])](#module_symbol-tree--SymbolTree+following) ⇒ <code>Object</code>
18-
* [.childrenToArray(parent, [options])](#module_symbol-tree--SymbolTree+childrenToArray) ⇒ <code>Array.&lt;Object&gt;</code>
19-
* [.ancestorsToArray(object, [options])](#module_symbol-tree--SymbolTree+ancestorsToArray) ⇒ <code>Array.&lt;Object&gt;</code>
20-
* [.treeToArray(root, [options])](#module_symbol-tree--SymbolTree+treeToArray) ⇒ <code>Array.&lt;Object&gt;</code>
21-
* [.childrenIterator(parent, [options])](#module_symbol-tree--SymbolTree+childrenIterator) ⇒ <code>Object</code>
22-
* [.previousSiblingsIterator(object)](#module_symbol-tree--SymbolTree+previousSiblingsIterator) ⇒ <code>Object</code>
23-
* [.nextSiblingsIterator(object)](#module_symbol-tree--SymbolTree+nextSiblingsIterator) ⇒ <code>Object</code>
24-
* [.ancestorsIterator(object)](#module_symbol-tree--SymbolTree+ancestorsIterator) ⇒ <code>Object</code>
25-
* [.treeIterator(root, options)](#module_symbol-tree--SymbolTree+treeIterator) ⇒ <code>Object</code>
26-
* [.index(child)](#module_symbol-tree--SymbolTree+index) ⇒ <code>Number</code>
27-
* [.childrenCount(parent)](#module_symbol-tree--SymbolTree+childrenCount) ⇒ <code>Number</code>
28-
* [.compareTreePosition(left, right)](#module_symbol-tree--SymbolTree+compareTreePosition) ⇒ <code>Number</code>
29-
* [.remove(removeObject)](#module_symbol-tree--SymbolTree+remove) ⇒ <code>Object</code>
30-
* [.insertBefore(referenceObject, newObject)](#module_symbol-tree--SymbolTree+insertBefore) ⇒ <code>Object</code>
31-
* [.insertAfter(referenceObject, newObject)](#module_symbol-tree--SymbolTree+insertAfter) ⇒ <code>Object</code>
32-
* [.prependChild(referenceObject, newObject)](#module_symbol-tree--SymbolTree+prependChild) ⇒ <code>Object</code>
33-
* [.appendChild(referenceObject, newObject)](#module_symbol-tree--SymbolTree+appendChild) ⇒ <code>Object</code>
7+
* [SymbolTree](#exp_module_symbol-tree--SymbolTree)
8+
* [new SymbolTree([description])](#new_module_symbol-tree--SymbolTree_new)
9+
* [.initialize(object)](#module_symbol-tree--SymbolTree+initialize) ⇒ <code>Object</code>
10+
* [.hasChildren(object)](#module_symbol-tree--SymbolTree+hasChildren) ⇒ <code>Boolean</code>
11+
* [.firstChild(object)](#module_symbol-tree--SymbolTree+firstChild) ⇒ <code>Object</code>
12+
* [.lastChild(object)](#module_symbol-tree--SymbolTree+lastChild) ⇒ <code>Object</code>
13+
* [.previousSibling(object)](#module_symbol-tree--SymbolTree+previousSibling) ⇒ <code>Object</code>
14+
* [.nextSibling(object)](#module_symbol-tree--SymbolTree+nextSibling) ⇒ <code>Object</code>
15+
* [.parent(object)](#module_symbol-tree--SymbolTree+parent) ⇒ <code>Object</code>
16+
* [.lastInclusiveDescendant(object)](#module_symbol-tree--SymbolTree+lastInclusiveDescendant) ⇒ <code>Object</code>
17+
* [.preceding(object, [options])](#module_symbol-tree--SymbolTree+preceding) ⇒ <code>Object</code>
18+
* [.following(object, [options])](#module_symbol-tree--SymbolTree+following) ⇒ <code>Object</code>
19+
* [.childrenToArray(parent, [options])](#module_symbol-tree--SymbolTree+childrenToArray) ⇒ <code>Array.&lt;Object&gt;</code>
20+
* [.ancestorsToArray(object, [options])](#module_symbol-tree--SymbolTree+ancestorsToArray) ⇒ <code>Array.&lt;Object&gt;</code>
21+
* [.treeToArray(root, [options])](#module_symbol-tree--SymbolTree+treeToArray) ⇒ <code>Array.&lt;Object&gt;</code>
22+
* [.childrenIterator(parent, [options])](#module_symbol-tree--SymbolTree+childrenIterator) ⇒ <code>Object</code>
23+
* [.previousSiblingsIterator(object)](#module_symbol-tree--SymbolTree+previousSiblingsIterator) ⇒ <code>Object</code>
24+
* [.nextSiblingsIterator(object)](#module_symbol-tree--SymbolTree+nextSiblingsIterator) ⇒ <code>Object</code>
25+
* [.ancestorsIterator(object)](#module_symbol-tree--SymbolTree+ancestorsIterator) ⇒ <code>Object</code>
26+
* [.treeIterator(root, options)](#module_symbol-tree--SymbolTree+treeIterator) ⇒ <code>Object</code>
27+
* [.index(child)](#module_symbol-tree--SymbolTree+index) ⇒ <code>Number</code>
28+
* [.childrenCount(parent)](#module_symbol-tree--SymbolTree+childrenCount) ⇒ <code>Number</code>
29+
* [.compareTreePosition(left, right)](#module_symbol-tree--SymbolTree+compareTreePosition) ⇒ <code>Number</code>
30+
* [.remove(removeObject)](#module_symbol-tree--SymbolTree+remove) ⇒ <code>Object</code>
31+
* [.insertBefore(referenceObject, newObject)](#module_symbol-tree--SymbolTree+insertBefore) ⇒ <code>Object</code>
32+
* [.insertAfter(referenceObject, newObject)](#module_symbol-tree--SymbolTree+insertAfter) ⇒ <code>Object</code>
33+
* [.prependChild(referenceObject, newObject)](#module_symbol-tree--SymbolTree+prependChild) ⇒ <code>Object</code>
34+
* [.appendChild(referenceObject, newObject)](#module_symbol-tree--SymbolTree+appendChild) ⇒ <code>Object</code>
3435

3536
<a name="exp_module_symbol-tree--SymbolTree"></a>
37+
3638
### SymbolTree ⏏
3739
**Kind**: Exported class
3840
<a name="new_module_symbol-tree--SymbolTree_new"></a>
41+
3942
#### new SymbolTree([description])
4043

41-
| Param | Default | Description |
42-
| --- | --- | --- |
43-
| [description] | <code>&#x27;SymbolTree data&#x27;</code> | Description used for the Symbol |
44+
| Param | Type | Default | Description |
45+
| --- | --- | --- | --- |
46+
| [description] | <code>string</code> | <code>&quot;&#x27;SymbolTree data&#x27;&quot;</code> | Description used for the Symbol |
4447

4548
<a name="module_symbol-tree--SymbolTree+initialize"></a>
49+
4650
#### symbolTree.initialize(object) ⇒ <code>Object</code>
4751
You can use this function to (optionally) initialize an object right after its creation,
4852
to take advantage of V8's fast properties. Also useful if you would like to
@@ -58,6 +62,7 @@ freeze your object.
5862
| object | <code>Object</code> |
5963

6064
<a name="module_symbol-tree--SymbolTree+hasChildren"></a>
65+
6166
#### symbolTree.hasChildren(object) ⇒ <code>Boolean</code>
6267
Returns `true` if the object has any children. Otherwise it returns `false`.
6368

@@ -70,6 +75,7 @@ Returns `true` if the object has any children. Otherwise it returns `false`.
7075
| object | <code>Object</code> |
7176

7277
<a name="module_symbol-tree--SymbolTree+firstChild"></a>
78+
7379
#### symbolTree.firstChild(object) ⇒ <code>Object</code>
7480
Returns the first child of the given object.
7581

@@ -82,6 +88,7 @@ Returns the first child of the given object.
8288
| object | <code>Object</code> |
8389

8490
<a name="module_symbol-tree--SymbolTree+lastChild"></a>
91+
8592
#### symbolTree.lastChild(object) ⇒ <code>Object</code>
8693
Returns the last child of the given object.
8794

@@ -94,6 +101,7 @@ Returns the last child of the given object.
94101
| object | <code>Object</code> |
95102

96103
<a name="module_symbol-tree--SymbolTree+previousSibling"></a>
104+
97105
#### symbolTree.previousSibling(object) ⇒ <code>Object</code>
98106
Returns the previous sibling of the given object.
99107

@@ -106,6 +114,7 @@ Returns the previous sibling of the given object.
106114
| object | <code>Object</code> |
107115

108116
<a name="module_symbol-tree--SymbolTree+nextSibling"></a>
117+
109118
#### symbolTree.nextSibling(object) ⇒ <code>Object</code>
110119
Returns the next sibling of the given object.
111120

@@ -118,6 +127,7 @@ Returns the next sibling of the given object.
118127
| object | <code>Object</code> |
119128

120129
<a name="module_symbol-tree--SymbolTree+parent"></a>
130+
121131
#### symbolTree.parent(object) ⇒ <code>Object</code>
122132
Return the parent of the given object.
123133

@@ -130,6 +140,7 @@ Return the parent of the given object.
130140
| object | <code>Object</code> |
131141

132142
<a name="module_symbol-tree--SymbolTree+lastInclusiveDescendant"></a>
143+
133144
#### symbolTree.lastInclusiveDescendant(object) ⇒ <code>Object</code>
134145
Find the inclusive descendant that is last in tree order of the given object.
135146

@@ -142,6 +153,7 @@ Find the inclusive descendant that is last in tree order of the given object.
142153
| object | <code>Object</code> |
143154

144155
<a name="module_symbol-tree--SymbolTree+preceding"></a>
156+
145157
#### symbolTree.preceding(object, [options]) ⇒ <code>Object</code>
146158
Find the preceding object (A) of the given object (B).
147159
An object A is preceding an object B if A and B are in the same tree
@@ -156,9 +168,10 @@ and A comes before B in tree order.
156168
| --- | --- | --- |
157169
| object | <code>Object</code> | |
158170
| [options] | <code>Object</code> | |
159-
| [options.root] | <code>Object</code> | If set, `root` must be an inclusive ancestor of the return value (or else null is returned). This check _assumes_ that `root` is also an inclusive ancestor of the given `node` |
171+
| [options.root] | <code>Object</code> | If set, `root` must be an inclusive ancestor of the return value (or else null is returned). This check _assumes_ that `root` is also an inclusive ancestor of the given `object` |
160172

161173
<a name="module_symbol-tree--SymbolTree+following"></a>
174+
162175
#### symbolTree.following(object, [options]) ⇒ <code>Object</code>
163176
Find the following object (A) of the given object (B).
164177
An object A is following an object B if A and B are in the same tree
@@ -173,10 +186,11 @@ and A comes after B in tree order.
173186
| --- | --- | --- | --- |
174187
| object | <code>Object</code> | | |
175188
| [options] | <code>Object</code> | | |
176-
| [options.root] | <code>Object</code> | | If set, `root` must be an inclusive ancestor of the return value (or else null is returned). This check _assumes_ that `root` is also an inclusive ancestor of the given `node` |
189+
| [options.root] | <code>Object</code> | | If set, `root` must be an inclusive ancestor of the return value (or else null is returned). This check _assumes_ that `root` is also an inclusive ancestor of the given `object` |
177190
| [options.skipChildren] | <code>Boolean</code> | <code>false</code> | If set, ignore the children of `object` |
178191

179192
<a name="module_symbol-tree--SymbolTree+childrenToArray"></a>
193+
180194
#### symbolTree.childrenToArray(parent, [options]) ⇒ <code>Array.&lt;Object&gt;</code>
181195
Append all children of the given object to an array.
182196

@@ -193,6 +207,7 @@ Append all children of the given object to an array.
193207
| [options.thisArg] | <code>\*</code> | | Value to use as `this` when executing `filter`. |
194208

195209
<a name="module_symbol-tree--SymbolTree+ancestorsToArray"></a>
210+
196211
#### symbolTree.ancestorsToArray(object, [options]) ⇒ <code>Array.&lt;Object&gt;</code>
197212
Append all inclusive ancestors of the given object to an array.
198213

@@ -209,6 +224,7 @@ Append all inclusive ancestors of the given object to an array.
209224
| [options.thisArg] | <code>\*</code> | | Value to use as `this` when executing `filter`. |
210225

211226
<a name="module_symbol-tree--SymbolTree+treeToArray"></a>
227+
212228
#### symbolTree.treeToArray(root, [options]) ⇒ <code>Array.&lt;Object&gt;</code>
213229
Append all descendants of the given object to an array (in tree order).
214230

@@ -225,6 +241,7 @@ Append all descendants of the given object to an array (in tree order).
225241
| [options.thisArg] | <code>\*</code> | | Value to use as `this` when executing `filter`. |
226242

227243
<a name="module_symbol-tree--SymbolTree+childrenIterator"></a>
244+
228245
#### symbolTree.childrenIterator(parent, [options]) ⇒ <code>Object</code>
229246
Iterate over all children of the given object
230247

@@ -240,6 +257,7 @@ Iterate over all children of the given object
240257
| [options.reverse] | <code>Boolean</code> | <code>false</code> |
241258

242259
<a name="module_symbol-tree--SymbolTree+previousSiblingsIterator"></a>
260+
243261
#### symbolTree.previousSiblingsIterator(object) ⇒ <code>Object</code>
244262
Iterate over all the previous siblings of the given object. (in reverse tree order)
245263

@@ -253,6 +271,7 @@ Iterate over all the previous siblings of the given object. (in reverse tree ord
253271
| object | <code>Object</code> |
254272

255273
<a name="module_symbol-tree--SymbolTree+nextSiblingsIterator"></a>
274+
256275
#### symbolTree.nextSiblingsIterator(object) ⇒ <code>Object</code>
257276
Iterate over all the next siblings of the given object. (in tree order)
258277

@@ -266,6 +285,7 @@ Iterate over all the next siblings of the given object. (in tree order)
266285
| object | <code>Object</code> |
267286

268287
<a name="module_symbol-tree--SymbolTree+ancestorsIterator"></a>
288+
269289
#### symbolTree.ancestorsIterator(object) ⇒ <code>Object</code>
270290
Iterate over all inclusive ancestors of the given object
271291

@@ -279,6 +299,7 @@ Iterate over all inclusive ancestors of the given object
279299
| object | <code>Object</code> |
280300

281301
<a name="module_symbol-tree--SymbolTree+treeIterator"></a>
302+
282303
#### symbolTree.treeIterator(root, options) ⇒ <code>Object</code>
283304
Iterate over all descendants of the given object (in tree order).
284305

@@ -297,6 +318,7 @@ Where `n` is the amount of objects in the sub-tree of the given `root`:
297318
| [options.reverse] | <code>Boolean</code> | <code>false</code> |
298319

299320
<a name="module_symbol-tree--SymbolTree+index"></a>
321+
300322
#### symbolTree.index(child) ⇒ <code>Number</code>
301323
Find the index of the given object (the number of preceding siblings).
302324

@@ -311,6 +333,7 @@ Find the index of the given object (the number of preceding siblings).
311333
| child | <code>Object</code> |
312334

313335
<a name="module_symbol-tree--SymbolTree+childrenCount"></a>
336+
314337
#### symbolTree.childrenCount(parent) ⇒ <code>Number</code>
315338
Calculate the number of children.
316339

@@ -324,6 +347,7 @@ Calculate the number of children.
324347
| parent | <code>Object</code> |
325348

326349
<a name="module_symbol-tree--SymbolTree+compareTreePosition"></a>
350+
327351
#### symbolTree.compareTreePosition(left, right) ⇒ <code>Number</code>
328352
Compare the position of an object relative to another object. A bit set is returned:
329353

@@ -352,6 +376,7 @@ where `o` is the amount of children of the lowest common ancestor of `left` and
352376
| right | <code>Object</code> |
353377

354378
<a name="module_symbol-tree--SymbolTree+remove"></a>
379+
355380
#### symbolTree.remove(removeObject) ⇒ <code>Object</code>
356381
Remove the object from this tree.
357382
Has no effect if already removed.
@@ -366,6 +391,7 @@ Has no effect if already removed.
366391
| removeObject | <code>Object</code> |
367392

368393
<a name="module_symbol-tree--SymbolTree+insertBefore"></a>
394+
369395
#### symbolTree.insertBefore(referenceObject, newObject) ⇒ <code>Object</code>
370396
Insert the given object before the reference object.
371397
`newObject` is now the previous sibling of `referenceObject`.
@@ -385,6 +411,7 @@ Insert the given object before the reference object.
385411
| newObject | <code>Object</code> |
386412

387413
<a name="module_symbol-tree--SymbolTree+insertAfter"></a>
414+
388415
#### symbolTree.insertAfter(referenceObject, newObject) ⇒ <code>Object</code>
389416
Insert the given object after the reference object.
390417
`newObject` is now the next sibling of `referenceObject`.
@@ -404,6 +431,7 @@ Insert the given object after the reference object.
404431
| newObject | <code>Object</code> |
405432

406433
<a name="module_symbol-tree--SymbolTree+prependChild"></a>
434+
407435
#### symbolTree.prependChild(referenceObject, newObject) ⇒ <code>Object</code>
408436
Insert the given object as the first child of the given reference object.
409437
`newObject` is now the first child of `referenceObject`.
@@ -423,6 +451,7 @@ Insert the given object as the first child of the given reference object.
423451
| newObject | <code>Object</code> |
424452

425453
<a name="module_symbol-tree--SymbolTree+appendChild"></a>
454+
426455
#### symbolTree.appendChild(referenceObject, newObject) ⇒ <code>Object</code>
427456
Insert the given object as the last child of the given reference object.
428457
`newObject` is now the last child of `referenceObject`.

0 commit comments

Comments
 (0)