Skip to content

v0.0.7 - docs update and version bump #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wtasg merged 1 commit into from
Dec 7, 2025
Merged

v0.0.7 - docs update and version bump #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 33 additions & 33 deletions docs/docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"fileName": "find.ts",
"line": 4,
"character": 4,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L4"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L4"
}
],
"type": {
Expand All @@ -40,7 +40,7 @@
"fileName": "find.ts",
"line": 4,
"character": 13,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L4"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L4"
}
],
"signatures": [
Expand All @@ -55,7 +55,7 @@
"fileName": "find.ts",
"line": 4,
"character": 13,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L4"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L4"
}
],
"parameters": [
Expand Down Expand Up @@ -96,7 +96,7 @@
"fileName": "find.ts",
"line": 4,
"character": 36,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L4"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L4"
}
],
"type": {
Expand All @@ -118,7 +118,7 @@
"fileName": "find.ts",
"line": 4,
"character": 34,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L4"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L4"
}
]
}
Expand Down Expand Up @@ -155,7 +155,7 @@
"fileName": "find.ts",
"line": 4,
"character": 72,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L4"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L4"
}
],
"type": {
Expand All @@ -174,7 +174,7 @@
"fileName": "find.ts",
"line": 4,
"character": 86,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L4"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L4"
}
],
"signatures": [
Expand All @@ -189,7 +189,7 @@
"fileName": "find.ts",
"line": 4,
"character": 86,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L4"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L4"
}
],
"type": {
Expand Down Expand Up @@ -219,7 +219,7 @@
"fileName": "find.ts",
"line": 4,
"character": 70,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L4"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L4"
}
]
}
Expand All @@ -245,7 +245,7 @@
"fileName": "find.ts",
"line": 5,
"character": 4,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L5"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L5"
}
],
"type": {
Expand All @@ -261,7 +261,7 @@
"fileName": "find.ts",
"line": 5,
"character": 10,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L5"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L5"
}
],
"signatures": [
Expand All @@ -276,7 +276,7 @@
"fileName": "find.ts",
"line": 5,
"character": 10,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L5"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L5"
}
],
"parameters": [
Expand Down Expand Up @@ -320,7 +320,7 @@
"fileName": "find.ts",
"line": 5,
"character": 38,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L5"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L5"
}
],
"signatures": [
Expand All @@ -335,7 +335,7 @@
"fileName": "find.ts",
"line": 5,
"character": 38,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L5"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L5"
}
],
"type": {
Expand All @@ -359,7 +359,7 @@
"fileName": "find.ts",
"line": 5,
"character": 36,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L5"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L5"
}
]
}
Expand Down Expand Up @@ -388,7 +388,7 @@
"fileName": "find.ts",
"line": 3,
"character": 10,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L3"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L3"
}
]
},
Expand All @@ -412,7 +412,7 @@
"fileName": "find.ts",
"line": 11,
"character": 4,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L11"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L11"
}
],
"type": {
Expand All @@ -438,7 +438,7 @@
"fileName": "find.ts",
"line": 11,
"character": 28,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L11"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L11"
}
],
"signatures": [
Expand All @@ -453,7 +453,7 @@
"fileName": "find.ts",
"line": 11,
"character": 28,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L11"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L11"
}
],
"parameters": [
Expand Down Expand Up @@ -504,7 +504,7 @@
"fileName": "find.ts",
"line": 12,
"character": 4,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L12"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L12"
}
],
"type": {
Expand All @@ -530,7 +530,7 @@
"fileName": "find.ts",
"line": 12,
"character": 28,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L12"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L12"
}
],
"signatures": [
Expand All @@ -545,7 +545,7 @@
"fileName": "find.ts",
"line": 12,
"character": 28,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L12"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L12"
}
],
"parameters": [
Expand Down Expand Up @@ -596,7 +596,7 @@
"fileName": "find.ts",
"line": 10,
"character": 4,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L10"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L10"
}
],
"type": {
Expand All @@ -617,7 +617,7 @@
"fileName": "find.ts",
"line": 9,
"character": 4,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L9"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L9"
}
],
"type": {
Expand All @@ -642,7 +642,7 @@
"fileName": "find.ts",
"line": 8,
"character": 10,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L8"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L8"
}
]
},
Expand All @@ -657,7 +657,7 @@
"fileName": "find.ts",
"line": 19,
"character": 9,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L19"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L19"
}
],
"signatures": [
Expand All @@ -680,7 +680,7 @@
"fileName": "find.ts",
"line": 19,
"character": 9,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L19"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L19"
}
],
"parameters": [
Expand Down Expand Up @@ -711,7 +711,7 @@
"fileName": "find.ts",
"line": 23,
"character": 26,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L23"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L23"
}
],
"signatures": [
Expand All @@ -726,7 +726,7 @@
"fileName": "find.ts",
"line": 23,
"character": 26,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L23"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L23"
}
],
"parameters": [
Expand Down Expand Up @@ -793,7 +793,7 @@
"fileName": "hello.ts",
"line": 6,
"character": 15,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/hello.ts#L6"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/hello.ts#L6"
}
],
"signatures": [
Expand Down Expand Up @@ -827,7 +827,7 @@
"fileName": "hello.ts",
"line": 6,
"character": 15,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/hello.ts#L6"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/hello.ts#L6"
}
],
"type": {
Expand Down Expand Up @@ -860,7 +860,7 @@
"fileName": "pojo.ts",
"line": 10,
"character": 9,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/pojo.ts#L10"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/pojo.ts#L10"
}
],
"signatures": [
Expand Down Expand Up @@ -894,7 +894,7 @@
"fileName": "pojo.ts",
"line": 10,
"character": 9,
"url": "https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/pojo.ts#L10"
"url": "https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/pojo.ts#L10"
}
],
"typeParameters": [
Expand Down
2 changes: 1 addition & 1 deletion docs/functions/createFindDirectories.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **createFindDirectories**(`deps`): (`root`, `options`) => `Promise`\<`string`[]\>

Defined in: [find.ts:19](https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L19)
Defined in: [find.ts:19](https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L19)

Factory that produces an async findDirectories function with
injected filesystem dependencies for full testability.
Expand Down
2 changes: 1 addition & 1 deletion docs/functions/hello.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **hello**(): `Promise`\<`string`\>

Defined in: [hello.ts:6](https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/hello.ts#L6)
Defined in: [hello.ts:6](https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/hello.ts#L6)

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

Expand Down
2 changes: 1 addition & 1 deletion docs/functions/pojo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **pojo**\<`T`\>(`instance`): `Record`\<`string`, `unknown`\>

Defined in: [pojo.ts:10](https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/pojo.ts#L10)
Defined in: [pojo.ts:10](https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/pojo.ts#L10)

Convert a class instance into a plain JavaScript object.
Copies only the instance's own enumerable data properties
Expand Down
6 changes: 3 additions & 3 deletions docs/interfaces/FileSystemDependencies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@

# Interface: FileSystemDependencies

Defined in: [find.ts:3](https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L3)
Defined in: [find.ts:3](https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L3)

## Properties

### readdir()

> **readdir**: (`path`, `opts`) => `Promise`\<`object`[]\>

Defined in: [find.ts:4](https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L4)
Defined in: [find.ts:4](https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L4)

#### Parameters

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

> **stat**: (`path`) => `Promise`\<\{ `isDirectory`: `boolean`; \}\>

Defined in: [find.ts:5](https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L5)
Defined in: [find.ts:5](https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L5)

#### Parameters

Expand Down
10 changes: 5 additions & 5 deletions docs/interfaces/FindDirectoriesOptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,36 +6,36 @@

# Interface: FindDirectoriesOptions

Defined in: [find.ts:8](https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L8)
Defined in: [find.ts:8](https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L8)

## Properties

### allowlist?

> `optional` **allowlist**: `string`[] \| (`absPath`, `name`) => `boolean`

Defined in: [find.ts:11](https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L11)
Defined in: [find.ts:11](https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L11)

***

### blocklist?

> `optional` **blocklist**: `string`[] \| (`absPath`, `name`) => `boolean`

Defined in: [find.ts:12](https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L12)
Defined in: [find.ts:12](https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L12)

***

### followSymlinks?

> `optional` **followSymlinks**: `boolean`

Defined in: [find.ts:10](https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L10)
Defined in: [find.ts:10](https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L10)

***

### maxDepth?

> `optional` **maxDepth**: `number`

Defined in: [find.ts:9](https://github.com/wtasg/node-lib/blob/cf7bf2c52d7290455ef5117574965703bedcc8a9/src/find.ts#L9)
Defined in: [find.ts:9](https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L9)
Loading
Loading