Skip to content

Commit 427c960

Browse files
committed
docs(readme): 📝 Fixed typo
1 parent d89204c commit 427c960

File tree

4 files changed

+18
-18
lines changed

4 files changed

+18
-18
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
## Introduction
99

10-
This module help interacting with `Tree` structures. It is optimized to work with big trees without causing overflows. Therefore it doesn't use recursion and the implementations for `preOrder` and `postOrder` traversals use `Promise.all` for concurrency to traverse multiple nodes at ones.
10+
This module helps interacting with `Tree` structures in TypeScript. It is optimized to work with big trees without causing overflows. Therefore it doesn't use recursion and the implementations for `preOrder` and `postOrder` traversals use `Promise.all` for concurrency to traverse multiple nodes at ones.
1111
It is fully typed and has over 95% test coverage.
1212

1313
🚀 Zero dependency<br>

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
## Introduction
1111

12-
This module help interacting with `Tree` structures. It is optimized to work with big trees without causing overflows. Therefore it doesn't use recursion and the implementations for `preOrder` and `postOrder` traversals use `Promise.all` for concurrency to traverse multiple nodes at ones.
12+
This module helps interacting with `Tree` structures in TypeScript. It is optimized to work with big trees without causing overflows. Therefore it doesn't use recursion and the implementations for `preOrder` and `postOrder` traversals use `Promise.all` for concurrency to traverse multiple nodes at ones.
1313
It is fully typed and has over 95% test coverage.
1414

1515
🚀 Zero dependency<br>

docs/classes/Tree.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Creates a new `Tree` instance.
4747

4848
#### Defined in
4949

50-
[Tree.ts:16](https://github.com/itpropro/tree-structure-ts/blob/b519647/src/Tree.ts#L16)
50+
[Tree.ts:16](https://github.com/itpropro/tree-structure-ts/blob/d89204c/src/Tree.ts#L16)
5151

5252
## Properties
5353

@@ -59,7 +59,7 @@ The root node of the tree.
5959

6060
#### Defined in
6161

62-
[Tree.ts:10](https://github.com/itpropro/tree-structure-ts/blob/b519647/src/Tree.ts#L10)
62+
[Tree.ts:10](https://github.com/itpropro/tree-structure-ts/blob/d89204c/src/Tree.ts#L10)
6363

6464
## Methods
6565

@@ -75,7 +75,7 @@ Returns all the nodes of the tree in an array.
7575

7676
#### Defined in
7777

78-
[Tree.ts:70](https://github.com/itpropro/tree-structure-ts/blob/b519647/src/Tree.ts#L70)
78+
[Tree.ts:70](https://github.com/itpropro/tree-structure-ts/blob/d89204c/src/Tree.ts#L70)
7979

8080
___
8181

@@ -99,4 +99,4 @@ calling the provided callback function on each visited node.
9999

100100
#### Defined in
101101

102-
[Tree.ts:27](https://github.com/itpropro/tree-structure-ts/blob/b519647/src/Tree.ts#L27)
102+
[Tree.ts:27](https://github.com/itpropro/tree-structure-ts/blob/d89204c/src/Tree.ts#L27)

docs/classes/TreeNode.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Creates a new TreeNode instance.
5656

5757
#### Defined in
5858

59-
[TreeNode.ts:25](https://github.com/itpropro/tree-structure-ts/blob/b519647/src/TreeNode.ts#L25)
59+
[TreeNode.ts:25](https://github.com/itpropro/tree-structure-ts/blob/d89204c/src/TreeNode.ts#L25)
6060

6161
## Properties
6262

@@ -68,7 +68,7 @@ The children of the node.
6868

6969
#### Defined in
7070

71-
[TreeNode.ts:13](https://github.com/itpropro/tree-structure-ts/blob/b519647/src/TreeNode.ts#L13)
71+
[TreeNode.ts:13](https://github.com/itpropro/tree-structure-ts/blob/d89204c/src/TreeNode.ts#L13)
7272

7373
___
7474

@@ -80,7 +80,7 @@ The parent of the node.
8080

8181
#### Defined in
8282

83-
[TreeNode.ts:18](https://github.com/itpropro/tree-structure-ts/blob/b519647/src/TreeNode.ts#L18)
83+
[TreeNode.ts:18](https://github.com/itpropro/tree-structure-ts/blob/d89204c/src/TreeNode.ts#L18)
8484

8585
___
8686

@@ -92,7 +92,7 @@ The value of the node.
9292

9393
#### Defined in
9494

95-
[TreeNode.ts:8](https://github.com/itpropro/tree-structure-ts/blob/b519647/src/TreeNode.ts#L8)
95+
[TreeNode.ts:8](https://github.com/itpropro/tree-structure-ts/blob/d89204c/src/TreeNode.ts#L8)
9696

9797
## Methods
9898

@@ -116,7 +116,7 @@ The new child node.
116116

117117
#### Defined in
118118

119-
[TreeNode.ts:36](https://github.com/itpropro/tree-structure-ts/blob/b519647/src/TreeNode.ts#L36)
119+
[TreeNode.ts:36](https://github.com/itpropro/tree-structure-ts/blob/d89204c/src/TreeNode.ts#L36)
120120

121121
___
122122

@@ -134,7 +134,7 @@ An array of TreeNode instances.
134134

135135
#### Defined in
136136

137-
[TreeNode.ts:46](https://github.com/itpropro/tree-structure-ts/blob/b519647/src/TreeNode.ts#L46)
137+
[TreeNode.ts:46](https://github.com/itpropro/tree-structure-ts/blob/d89204c/src/TreeNode.ts#L46)
138138

139139
___
140140

@@ -152,7 +152,7 @@ An array of TreeNode instances.
152152

153153
#### Defined in
154154

155-
[TreeNode.ts:59](https://github.com/itpropro/tree-structure-ts/blob/b519647/src/TreeNode.ts#L59)
155+
[TreeNode.ts:59](https://github.com/itpropro/tree-structure-ts/blob/d89204c/src/TreeNode.ts#L59)
156156

157157
___
158158

@@ -170,7 +170,7 @@ Checks if the current node has any child nodes.
170170

171171
#### Defined in
172172

173-
[TreeNode.ts:75](https://github.com/itpropro/tree-structure-ts/blob/b519647/src/TreeNode.ts#L75)
173+
[TreeNode.ts:75](https://github.com/itpropro/tree-structure-ts/blob/d89204c/src/TreeNode.ts#L75)
174174

175175
___
176176

@@ -188,7 +188,7 @@ Checks if the current node has any siblings.
188188

189189
#### Defined in
190190

191-
[TreeNode.ts:83](https://github.com/itpropro/tree-structure-ts/blob/b519647/src/TreeNode.ts#L83)
191+
[TreeNode.ts:83](https://github.com/itpropro/tree-structure-ts/blob/d89204c/src/TreeNode.ts#L83)
192192

193193
___
194194

@@ -206,7 +206,7 @@ Checks if the current node is the root node.
206206

207207
#### Defined in
208208

209-
[TreeNode.ts:91](https://github.com/itpropro/tree-structure-ts/blob/b519647/src/TreeNode.ts#L91)
209+
[TreeNode.ts:91](https://github.com/itpropro/tree-structure-ts/blob/d89204c/src/TreeNode.ts#L91)
210210

211211
___
212212

@@ -224,7 +224,7 @@ The new current node after removing the current node.
224224

225225
#### Defined in
226226

227-
[TreeNode.ts:99](https://github.com/itpropro/tree-structure-ts/blob/b519647/src/TreeNode.ts#L99)
227+
[TreeNode.ts:99](https://github.com/itpropro/tree-structure-ts/blob/d89204c/src/TreeNode.ts#L99)
228228

229229
___
230230

@@ -247,4 +247,4 @@ Traverses the tree starting from the current node.
247247

248248
#### Defined in
249249

250-
[TreeNode.ts:119](https://github.com/itpropro/tree-structure-ts/blob/b519647/src/TreeNode.ts#L119)
250+
[TreeNode.ts:119](https://github.com/itpropro/tree-structure-ts/blob/d89204c/src/TreeNode.ts#L119)

0 commit comments

Comments
 (0)