Skip to content

Commit e9a275d

Browse files
committed
Updated RecursiveType javadoc in dist
1 parent 243ae0d commit e9a275d

File tree

2 files changed

+22
-60
lines changed

2 files changed

+22
-60
lines changed

dist/types/recursive.d.ts

Lines changed: 11 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,9 @@ import Type from './type';
2525
* For example, say the value was created with the following code:
2626
* ````javascript
2727
* let selfType = new sb.RecursiveType('self-type')
28-
* sb.registerType({
29-
* type: new sb.StructType({
30-
* self: selfType
31-
* }),
32-
* name: 'self-type'
33-
* })
28+
* selfType.setType(new sb.StructType({
29+
* self: selfType
30+
* }))
3431
* let self = {} //note that we had to give self a "base value" of {}
3532
* self.self = self
3633
* ````
@@ -54,14 +51,11 @@ import Type from './type';
5451
* ````javascript
5552
* //A binary tree of unsigned bytes
5653
* let treeType = new sb.RecursiveType('tree-node')
57-
* sb.registerType({
58-
* type: new sb.StructType({
59-
* left: new sb.OptionalType(treeType),
60-
* value: new sb.UnsignedByteType,
61-
* right: new sb.OptionalType(treeType)
62-
* }),
63-
* name: 'tree-node' //name must match name passed to RecursiveType constructor
64-
* })
54+
* treeType.setType(new sb.StructType({
55+
* left: new sb.OptionalType(treeType),
56+
* value: new sb.UnsignedByteType,
57+
* right: new sb.OptionalType(treeType)
58+
* }))
6559
* ````
6660
*
6761
* @param E The type of value this type can write
@@ -88,27 +82,14 @@ export default class RecursiveType<E, READ_E extends E = E> extends AbsoluteType
8882
* ````javascript
8983
* treeType.writeValue(buffer, {
9084
* left: {
91-
* left: {
92-
* left: null,
93-
* value: 1,
94-
* right: null
95-
* },
85+
* left: {value: 1},
9686
* value: 2,
97-
* right: {
98-
* left: null,
99-
* value: 3,
100-
* right: null
101-
* }
87+
* right: {value: 3}
10288
* },
10389
* value: 4,
10490
* right: {
105-
* left: null,
10691
* value: 5,
107-
* right: {
108-
* left: null,
109-
* value: 6,
110-
* right: null
111-
* }
92+
* right: {value: 6}
11293
* }
11394
* })
11495
* ````

dist/types/recursive.js

Lines changed: 11 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,9 @@ const readRecursives = new WeakMap();
3434
* For example, say the value was created with the following code:
3535
* ````javascript
3636
* let selfType = new sb.RecursiveType('self-type')
37-
* sb.registerType({
38-
* type: new sb.StructType({
39-
* self: selfType
40-
* }),
41-
* name: 'self-type'
42-
* })
37+
* selfType.setType(new sb.StructType({
38+
* self: selfType
39+
* }))
4340
* let self = {} //note that we had to give self a "base value" of {}
4441
* self.self = self
4542
* ````
@@ -63,14 +60,11 @@ const readRecursives = new WeakMap();
6360
* ````javascript
6461
* //A binary tree of unsigned bytes
6562
* let treeType = new sb.RecursiveType('tree-node')
66-
* sb.registerType({
67-
* type: new sb.StructType({
68-
* left: new sb.OptionalType(treeType),
69-
* value: new sb.UnsignedByteType,
70-
* right: new sb.OptionalType(treeType)
71-
* }),
72-
* name: 'tree-node' //name must match name passed to RecursiveType constructor
73-
* })
63+
* treeType.setType(new sb.StructType({
64+
* left: new sb.OptionalType(treeType),
65+
* value: new sb.UnsignedByteType,
66+
* right: new sb.OptionalType(treeType)
67+
* }))
7468
* ````
7569
*
7670
* @param E The type of value this type can write
@@ -127,27 +121,14 @@ class RecursiveType extends absolute_1.default {
127121
* ````javascript
128122
* treeType.writeValue(buffer, {
129123
* left: {
130-
* left: {
131-
* left: null,
132-
* value: 1,
133-
* right: null
134-
* },
124+
* left: {value: 1},
135125
* value: 2,
136-
* right: {
137-
* left: null,
138-
* value: 3,
139-
* right: null
140-
* }
126+
* right: {value: 3}
141127
* },
142128
* value: 4,
143129
* right: {
144-
* left: null,
145130
* value: 5,
146-
* right: {
147-
* left: null,
148-
* value: 6,
149-
* right: null
150-
* }
131+
* right: {value: 6}
151132
* }
152133
* })
153134
* ````

0 commit comments

Comments
 (0)