Skip to content

Commit 0459671

Browse files
wtasgwtasg
committed
updates
1 parent 0a35c87 commit 0459671

8 files changed

Lines changed: 63 additions & 45 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ A library project for nodejs. #nodejs #typescript #library
99

1010
1. hello (for debugging)
1111
2. `pojo` for converting class objects to Plain Old Javascript Objects.
12+
3. `createFindDirectories` as a factory for finding directories; think `find path -type d`.
1213

1314
## Develop
1415

‎docs/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ A library project for nodejs. #nodejs #typescript #library
1313

1414
1. hello (for debugging)
1515
2. `pojo` for converting class objects to Plain Old Javascript Objects.
16+
3. `createFindDirectories` as a factory for finding directories; think `find path -type d`.
1617

1718
## Develop
1819

‎docs/docs.json‎

Lines changed: 50 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
"fileName": "find.ts",
2525
"line": 4,
2626
"character": 4,
27-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L4"
27+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L4"
2828
}
2929
],
3030
"type": {
@@ -40,7 +40,7 @@
4040
"fileName": "find.ts",
4141
"line": 4,
4242
"character": 13,
43-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L4"
43+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L4"
4444
}
4545
],
4646
"signatures": [
@@ -55,7 +55,7 @@
5555
"fileName": "find.ts",
5656
"line": 4,
5757
"character": 13,
58-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L4"
58+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L4"
5959
}
6060
],
6161
"parameters": [
@@ -96,7 +96,7 @@
9696
"fileName": "find.ts",
9797
"line": 4,
9898
"character": 36,
99-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L4"
99+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L4"
100100
}
101101
],
102102
"type": {
@@ -118,7 +118,7 @@
118118
"fileName": "find.ts",
119119
"line": 4,
120120
"character": 34,
121-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L4"
121+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L4"
122122
}
123123
]
124124
}
@@ -155,7 +155,7 @@
155155
"fileName": "find.ts",
156156
"line": 4,
157157
"character": 72,
158-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L4"
158+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L4"
159159
}
160160
],
161161
"type": {
@@ -174,7 +174,7 @@
174174
"fileName": "find.ts",
175175
"line": 4,
176176
"character": 86,
177-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L4"
177+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L4"
178178
}
179179
],
180180
"signatures": [
@@ -189,7 +189,7 @@
189189
"fileName": "find.ts",
190190
"line": 4,
191191
"character": 86,
192-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L4"
192+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L4"
193193
}
194194
],
195195
"type": {
@@ -219,7 +219,7 @@
219219
"fileName": "find.ts",
220220
"line": 4,
221221
"character": 70,
222-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L4"
222+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L4"
223223
}
224224
]
225225
}
@@ -245,7 +245,7 @@
245245
"fileName": "find.ts",
246246
"line": 5,
247247
"character": 4,
248-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L5"
248+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L5"
249249
}
250250
],
251251
"type": {
@@ -261,7 +261,7 @@
261261
"fileName": "find.ts",
262262
"line": 5,
263263
"character": 10,
264-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L5"
264+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L5"
265265
}
266266
],
267267
"signatures": [
@@ -276,7 +276,7 @@
276276
"fileName": "find.ts",
277277
"line": 5,
278278
"character": 10,
279-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L5"
279+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L5"
280280
}
281281
],
282282
"parameters": [
@@ -320,7 +320,7 @@
320320
"fileName": "find.ts",
321321
"line": 5,
322322
"character": 38,
323-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L5"
323+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L5"
324324
}
325325
],
326326
"signatures": [
@@ -335,7 +335,7 @@
335335
"fileName": "find.ts",
336336
"line": 5,
337337
"character": 38,
338-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L5"
338+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L5"
339339
}
340340
],
341341
"type": {
@@ -359,7 +359,7 @@
359359
"fileName": "find.ts",
360360
"line": 5,
361361
"character": 36,
362-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L5"
362+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L5"
363363
}
364364
]
365365
}
@@ -388,7 +388,7 @@
388388
"fileName": "find.ts",
389389
"line": 3,
390390
"character": 10,
391-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L3"
391+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L3"
392392
}
393393
]
394394
},
@@ -412,7 +412,7 @@
412412
"fileName": "find.ts",
413413
"line": 11,
414414
"character": 4,
415-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L11"
415+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L11"
416416
}
417417
],
418418
"type": {
@@ -438,7 +438,7 @@
438438
"fileName": "find.ts",
439439
"line": 11,
440440
"character": 28,
441-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L11"
441+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L11"
442442
}
443443
],
444444
"signatures": [
@@ -453,7 +453,7 @@
453453
"fileName": "find.ts",
454454
"line": 11,
455455
"character": 28,
456-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L11"
456+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L11"
457457
}
458458
],
459459
"parameters": [
@@ -504,7 +504,7 @@
504504
"fileName": "find.ts",
505505
"line": 12,
506506
"character": 4,
507-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L12"
507+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L12"
508508
}
509509
],
510510
"type": {
@@ -530,7 +530,7 @@
530530
"fileName": "find.ts",
531531
"line": 12,
532532
"character": 28,
533-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L12"
533+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L12"
534534
}
535535
],
536536
"signatures": [
@@ -545,7 +545,7 @@
545545
"fileName": "find.ts",
546546
"line": 12,
547547
"character": 28,
548-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L12"
548+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L12"
549549
}
550550
],
551551
"parameters": [
@@ -596,7 +596,7 @@
596596
"fileName": "find.ts",
597597
"line": 10,
598598
"character": 4,
599-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L10"
599+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L10"
600600
}
601601
],
602602
"type": {
@@ -617,7 +617,7 @@
617617
"fileName": "find.ts",
618618
"line": 9,
619619
"character": 4,
620-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L9"
620+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L9"
621621
}
622622
],
623623
"type": {
@@ -642,7 +642,7 @@
642642
"fileName": "find.ts",
643643
"line": 8,
644644
"character": 10,
645-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L8"
645+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L8"
646646
}
647647
]
648648
},
@@ -657,7 +657,7 @@
657657
"fileName": "find.ts",
658658
"line": 19,
659659
"character": 9,
660-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L19"
660+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L19"
661661
}
662662
],
663663
"signatures": [
@@ -680,7 +680,7 @@
680680
"fileName": "find.ts",
681681
"line": 19,
682682
"character": 9,
683-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L19"
683+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L19"
684684
}
685685
],
686686
"parameters": [
@@ -711,7 +711,7 @@
711711
"fileName": "find.ts",
712712
"line": 23,
713713
"character": 26,
714-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L23"
714+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L23"
715715
}
716716
],
717717
"signatures": [
@@ -726,7 +726,7 @@
726726
"fileName": "find.ts",
727727
"line": 23,
728728
"character": 26,
729-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L23"
729+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L23"
730730
}
731731
],
732732
"parameters": [
@@ -793,7 +793,7 @@
793793
"fileName": "hello.ts",
794794
"line": 6,
795795
"character": 15,
796-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/hello.ts#L6"
796+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/hello.ts#L6"
797797
}
798798
],
799799
"signatures": [
@@ -827,7 +827,7 @@
827827
"fileName": "hello.ts",
828828
"line": 6,
829829
"character": 15,
830-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/hello.ts#L6"
830+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/hello.ts#L6"
831831
}
832832
],
833833
"type": {
@@ -860,7 +860,7 @@
860860
"fileName": "pojo.ts",
861861
"line": 10,
862862
"character": 9,
863-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/pojo.ts#L10"
863+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/pojo.ts#L10"
864864
}
865865
],
866866
"signatures": [
@@ -894,7 +894,7 @@
894894
"fileName": "pojo.ts",
895895
"line": 10,
896896
"character": 9,
897-
"url": "https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/pojo.ts#L10"
897+
"url": "https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/pojo.ts#L10"
898898
}
899899
],
900900
"typeParameters": [
@@ -987,7 +987,23 @@
987987
},
988988
{
989989
"kind": "text",
990-
"text": " for converting class objects to Plain Old Javascript Objects.\n\n## Develop\n\n"
990+
"text": " for converting class objects to Plain Old Javascript Objects.\n3. "
991+
},
992+
{
993+
"kind": "code",
994+
"text": "`createFindDirectories`"
995+
},
996+
{
997+
"kind": "text",
998+
"text": " as a factory for finding directories; think "
999+
},
1000+
{
1001+
"kind": "code",
1002+
"text": "`find path -type d`"
1003+
},
1004+
{
1005+
"kind": "text",
1006+
"text": ".\n\n## Develop\n\n"
9911007
},
9921008
{
9931009
"kind": "code",

‎docs/functions/createFindDirectories.md‎

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

99
> **createFindDirectories**(`deps`): (`root`, `options`) => `Promise`\<`string`[]\>
1010
11-
Defined in: [find.ts:19](https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L19)
11+
Defined in: [find.ts:19](https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L19)
1212

1313
Factory that produces an async findDirectories function with
1414
injected filesystem dependencies for full testability.

‎docs/functions/hello.md‎

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

99
> **hello**(): `Promise`\<`string`\>
1010
11-
Defined in: [hello.ts:6](https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/hello.ts#L6)
11+
Defined in: [hello.ts:6](https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/hello.ts#L6)
1212

1313
A sample function that should work to test if lib is installed correctly.
1414

‎docs/functions/pojo.md‎

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

99
> **pojo**\<`T`\>(`instance`): `Record`\<`string`, `any`\>
1010
11-
Defined in: [pojo.ts:10](https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/pojo.ts#L10)
11+
Defined in: [pojo.ts:10](https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/pojo.ts#L10)
1212

1313
Convert a class instance into a plain JavaScript object.
1414
Copies only the instance's own enumerable data properties

‎docs/interfaces/FileSystemDependencies.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66

77
# Interface: FileSystemDependencies
88

9-
Defined in: [find.ts:3](https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L3)
9+
Defined in: [find.ts:3](https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L3)
1010

1111
## Properties
1212

1313
### readdir()
1414

1515
> **readdir**: (`path`, `opts`) => `Promise`\<`object`[]\>
1616
17-
Defined in: [find.ts:4](https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L4)
17+
Defined in: [find.ts:4](https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L4)
1818

1919
#### Parameters
2020

@@ -38,7 +38,7 @@ Defined in: [find.ts:4](https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c
3838

3939
> **stat**: (`path`) => `Promise`\<\{ `isDirectory`: `boolean`; \}\>
4040
41-
Defined in: [find.ts:5](https://github.com/wtasg/node-lib/blob/82e4a89a7a2830f8c6f7927d31bb49ee2cf4d772/src/find.ts#L5)
41+
Defined in: [find.ts:5](https://github.com/wtasg/node-lib/blob/0a35c87c8e5bb7668104497f91311a467e53c78e/src/find.ts#L5)
4242

4343
#### Parameters
4444

0 commit comments

Comments
 (0)