@wtasnorg/node-lib 0.0.9 → 0.0.11

package/docs/functions/createFindDirectories.md

@@ -8,7 +8,7 @@
 
 > **createFindDirectories**(`deps`): (`root`, `options`) => `Promise`\<`string`[]\>
 
-Defined in: [find.ts:19](https://github.com/wtasg/node-lib/blob/b5efd5c345e8fa1bdc2a6d3ea4dd4b2eb5b9cc62/src/find.ts#L19)
+Defined in: [find.ts:19](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/find.ts#L19)
 
 Factory that produces an async findDirectories function with
 injected filesystem dependencies for full testability.

package/docs/functions/decode.md

@@ -8,7 +8,7 @@
 
 > **decode**(`input`, `charset`): `string`
 
-Defined in: base64.ts:119
+Defined in: [base64.ts:119](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/base64.ts#L119)
 
 Decode a Base64 string.
 

package/docs/functions/decode32.md

@@ -0,0 +1,49 @@
+[**@wtasnorg/node-lib**](../README.md)
+
+***
+
+[@wtasnorg/node-lib](../README.md) / decode32
+
+# Function: decode32()
+
+> **decode32**(`input`, `charset`): `string`
+
+Defined in: [base32.ts:136](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/base32.ts#L136)
+
+Decode a Base32 string.
+
+## Parameters
+
+### input
+
+`string`
+
+The Base32 encoded string.
+
+### charset
+
+The charset variant to use (default: "rfc4648").
+
+`"rfc4648"` | `"hex"` | `"crockford"`
+
+## Returns
+
+`string`
+
+The decoded string.
+
+## Example
+
+```typescript
+import { decode32 } from "./base32.js";
+
+decode32("JBSWY3DP");
+// => "Hello"
+
+decode32("EHMP6SS=", "hex");
+// => "test"
+```
+
+## Throws
+
+Error if the input contains invalid characters.

package/docs/functions/decode58.md

@@ -0,0 +1,49 @@
+[**@wtasnorg/node-lib**](../README.md)
+
+***
+
+[@wtasnorg/node-lib](../README.md) / decode58
+
+# Function: decode58()
+
+> **decode58**(`input`, `charset`): `string`
+
+Defined in: [base58.ts:132](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/base58.ts#L132)
+
+Decode a Base58 string.
+
+## Parameters
+
+### input
+
+`string`
+
+The Base58 encoded string.
+
+### charset
+
+The charset variant to use (default: "bitcoin").
+
+`"bitcoin"` | `"flickr"` | `"ripple"`
+
+## Returns
+
+`string`
+
+The decoded string.
+
+## Example
+
+```typescript
+import { decode58 } from "./base58.js";
+
+decode58("JxF12TrwUP45BMd");
+// => "Hello World"
+
+decode58("jXf12sRWto45bmD", "flickr");
+// => "Hello World"
+```
+
+## Throws
+
+Error if the input contains invalid characters.

package/docs/functions/decode85.md

@@ -0,0 +1,49 @@
+[**@wtasnorg/node-lib**](../README.md)
+
+***
+
+[@wtasnorg/node-lib](../README.md) / decode85
+
+# Function: decode85()
+
+> **decode85**(`input`, `charset`): `string`
+
+Defined in: [base85.ts:135](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/base85.ts#L135)
+
+Decode a Base85 string.
+
+## Parameters
+
+### input
+
+`string`
+
+The Base85 encoded string.
+
+### charset
+
+The charset variant to use (default: "ascii85").
+
+`"ascii85"` | `"z85"` | `"rfc1924"`
+
+## Returns
+
+`string`
+
+The decoded string.
+
+## Example
+
+```typescript
+import { decode85 } from "./base85.js";
+
+decode85("87cURDZ");
+// => "Hello"
+
+decode85("wrx.P", "z85");
+// => "test"
+```
+
+## Throws
+
+Error if the input contains invalid characters.

package/docs/functions/encode.md

@@ -8,7 +8,7 @@
 
 > **encode**(`input`, `charset`): `string`
 
-Defined in: base64.ts:79
+Defined in: [base64.ts:79](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/base64.ts#L79)
 
 Encode a string to Base64.
 

package/docs/functions/encode32.md

@@ -0,0 +1,45 @@
+[**@wtasnorg/node-lib**](../README.md)
+
+***
+
+[@wtasnorg/node-lib](../README.md) / encode32
+
+# Function: encode32()
+
+> **encode32**(`input`, `charset`): `string`
+
+Defined in: [base32.ts:81](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/base32.ts#L81)
+
+Encode a string to Base32.
+
+## Parameters
+
+### input
+
+`string`
+
+The string to encode.
+
+### charset
+
+The charset variant to use (default: "rfc4648").
+
+`"rfc4648"` | `"hex"` | `"crockford"`
+
+## Returns
+
+`string`
+
+The Base32 encoded string.
+
+## Example
+
+```typescript
+import { encode32 } from "./base32.js";
+
+encode32("Hello");
+// => "JBSWY3DP"
+
+encode32("test", "hex");
+// => "EHMP6SS="
+```

package/docs/functions/encode58.md

@@ -0,0 +1,45 @@
+[**@wtasnorg/node-lib**](../README.md)
+
+***
+
+[@wtasnorg/node-lib](../README.md) / encode58
+
+# Function: encode58()
+
+> **encode58**(`input`, `charset`): `string`
+
+Defined in: [base58.ts:72](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/base58.ts#L72)
+
+Encode a string to Base58.
+
+## Parameters
+
+### input
+
+`string`
+
+The string to encode.
+
+### charset
+
+The charset variant to use (default: "bitcoin").
+
+`"bitcoin"` | `"flickr"` | `"ripple"`
+
+## Returns
+
+`string`
+
+The Base58 encoded string.
+
+## Example
+
+```typescript
+import { encode58 } from "./base58.js";
+
+encode58("Hello World");
+// => "JxF12TrwUP45BMd"
+
+encode58("Hello World", "flickr");
+// => "jXf12sRWto45bmD"
+```

package/docs/functions/encode85.md

@@ -0,0 +1,45 @@
+[**@wtasnorg/node-lib**](../README.md)
+
+***
+
+[@wtasnorg/node-lib](../README.md) / encode85
+
+# Function: encode85()
+
+> **encode85**(`input`, `charset`): `string`
+
+Defined in: [base85.ts:73](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/base85.ts#L73)
+
+Encode a string to Base85.
+
+## Parameters
+
+### input
+
+`string`
+
+The string to encode.
+
+### charset
+
+The charset variant to use (default: "ascii85").
+
+`"ascii85"` | `"z85"` | `"rfc1924"`
+
+## Returns
+
+`string`
+
+The Base85 encoded string.
+
+## Example
+
+```typescript
+import { encode85 } from "./base85.js";
+
+encode85("Hello");
+// => "87cURDZ"
+
+encode85("test", "z85");
+// => "wrx.P"
+```

package/docs/functions/hello.md

@@ -6,14 +6,46 @@
 
 # Function: hello()
 
-> **hello**(): `Promise`\<`string`\>
+> **hello**(`konsole?`): `Promise`\<`string`\>
 
-Defined in: [hello.ts:6](https://github.com/wtasg/node-lib/blob/b5efd5c345e8fa1bdc2a6d3ea4dd4b2eb5b9cc62/src/hello.ts#L6)
+Defined in: [hello.ts:31](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/hello.ts#L31)
 
 A sample function that should work to test if lib is installed correctly.
 
+## Parameters
+
+### konsole?
+
+`Console`
+
+optional console object to log the message
+
 ## Returns
 
 `Promise`\<`string`\>
 
-hello message
+`hello from @wtasnorg/node-lib`
+
+## Examples
+
+```ts
+import { hello } from "@wtasnorg/node-lib";
+
+async function main() {
+    const message = await hello(console);
+    console.log("Received message:", message);
+}
+
+main();
+```
+
+```ts
+import { hello } from "@wtasnorg/node-lib";
+
+async function main() {
+    const message = await hello();
+    // Do something with the message
+}
+
+main();
+```

package/docs/functions/parseUserAgent.md

@@ -8,7 +8,7 @@
 
 > **parseUserAgent**(`ua`): [`UserAgentInfo`](../interfaces/UserAgentInfo.md)
 
-Defined in: [user-agent.ts:48](https://github.com/wtasg/node-lib/blob/b5efd5c345e8fa1bdc2a6d3ea4dd4b2eb5b9cc62/src/user-agent.ts#L48)
+Defined in: [user-agent.ts:48](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/user-agent.ts#L48)
 
 Parses a user-agent string into a UserAgentInfo object.
 

package/docs/functions/pojo.md

@@ -8,7 +8,7 @@
 
 > **pojo**\<`T`\>(`instance`): `Record`\<`string`, `unknown`\>
 
-Defined in: [pojo.ts:10](https://github.com/wtasg/node-lib/blob/b5efd5c345e8fa1bdc2a6d3ea4dd4b2eb5b9cc62/src/pojo.ts#L10)
+Defined in: [pojo.ts:10](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/pojo.ts#L10)
 
 Convert a class instance into a plain JavaScript object.
 Copies only the instance's own enumerable data properties

package/docs/interfaces/FileSystemDependencies.md

@@ -6,7 +6,7 @@
 
 # Interface: FileSystemDependencies
 
-Defined in: [find.ts:3](https://github.com/wtasg/node-lib/blob/b5efd5c345e8fa1bdc2a6d3ea4dd4b2eb5b9cc62/src/find.ts#L3)
+Defined in: [find.ts:3](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/find.ts#L3)
 
 ## Properties
 
@@ -14,7 +14,7 @@ Defined in: [find.ts:3](https://github.com/wtasg/node-lib/blob/b5efd5c345e8fa1bd
 
 > **readdir**: (`_path`, `_opts`) => `Promise`\<`object`[]\>
 
-Defined in: [find.ts:4](https://github.com/wtasg/node-lib/blob/b5efd5c345e8fa1bdc2a6d3ea4dd4b2eb5b9cc62/src/find.ts#L4)
+Defined in: [find.ts:4](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/find.ts#L4)
 
 #### Parameters
 
@@ -38,7 +38,7 @@ Defined in: [find.ts:4](https://github.com/wtasg/node-lib/blob/b5efd5c345e8fa1bd
 
 > **stat**: (`_path`) => `Promise`\<\{ `isDirectory`: `boolean`; \}\>
 
-Defined in: [find.ts:5](https://github.com/wtasg/node-lib/blob/b5efd5c345e8fa1bdc2a6d3ea4dd4b2eb5b9cc62/src/find.ts#L5)
+Defined in: [find.ts:5](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/find.ts#L5)
 
 #### Parameters
 

package/docs/interfaces/FindDirectoriesOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: FindDirectoriesOptions
 
-Defined in: [find.ts:8](https://github.com/wtasg/node-lib/blob/b5efd5c345e8fa1bdc2a6d3ea4dd4b2eb5b9cc62/src/find.ts#L8)
+Defined in: [find.ts:8](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/find.ts#L8)
 
 ## Properties
 
@@ -14,7 +14,7 @@ Defined in: [find.ts:8](https://github.com/wtasg/node-lib/blob/b5efd5c345e8fa1bd
 
 > `optional` **allowlist**: `string`[] \| (`_absPath`, `_name`) => `boolean`
 
-Defined in: [find.ts:11](https://github.com/wtasg/node-lib/blob/b5efd5c345e8fa1bdc2a6d3ea4dd4b2eb5b9cc62/src/find.ts#L11)
+Defined in: [find.ts:11](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/find.ts#L11)
 
 ***
 
@@ -22,7 +22,7 @@ Defined in: [find.ts:11](https://github.com/wtasg/node-lib/blob/b5efd5c345e8fa1b
 
 > `optional` **blocklist**: `string`[] \| (`_absPath`, `_name`) => `boolean`
 
-Defined in: [find.ts:12](https://github.com/wtasg/node-lib/blob/b5efd5c345e8fa1bdc2a6d3ea4dd4b2eb5b9cc62/src/find.ts#L12)
+Defined in: [find.ts:12](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/find.ts#L12)
 
 ***
 
@@ -30,7 +30,7 @@ Defined in: [find.ts:12](https://github.com/wtasg/node-lib/blob/b5efd5c345e8fa1b
 
 > `optional` **followSymlinks**: `boolean`
 
-Defined in: [find.ts:10](https://github.com/wtasg/node-lib/blob/b5efd5c345e8fa1bdc2a6d3ea4dd4b2eb5b9cc62/src/find.ts#L10)
+Defined in: [find.ts:10](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/find.ts#L10)
 
 ***
 
@@ -38,4 +38,4 @@ Defined in: [find.ts:10](https://github.com/wtasg/node-lib/blob/b5efd5c345e8fa1b
 
 > `optional` **maxDepth**: `number`
 
-Defined in: [find.ts:9](https://github.com/wtasg/node-lib/blob/b5efd5c345e8fa1bdc2a6d3ea4dd4b2eb5b9cc62/src/find.ts#L9)
+Defined in: [find.ts:9](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/find.ts#L9)

package/docs/interfaces/UserAgentInfo.md

@@ -6,7 +6,7 @@
 
 # Interface: UserAgentInfo
 
-Defined in: [user-agent.ts:4](https://github.com/wtasg/node-lib/blob/b5efd5c345e8fa1bdc2a6d3ea4dd4b2eb5b9cc62/src/user-agent.ts#L4)
+Defined in: [user-agent.ts:4](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/user-agent.ts#L4)
 
 Information extracted from a user-agent string.
 
@@ -16,7 +16,7 @@ Information extracted from a user-agent string.
 
 > **browser**: `string`
 
-Defined in: [user-agent.ts:8](https://github.com/wtasg/node-lib/blob/b5efd5c345e8fa1bdc2a6d3ea4dd4b2eb5b9cc62/src/user-agent.ts#L8)
+Defined in: [user-agent.ts:8](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/user-agent.ts#L8)
 
 Browser name (e.g., Chrome, Firefox, Safari, Edge, Opera, Other).
 
@@ -26,7 +26,7 @@ Browser name (e.g., Chrome, Firefox, Safari, Edge, Opera, Other).
 
 > **device**: `string`
 
-Defined in: [user-agent.ts:20](https://github.com/wtasg/node-lib/blob/b5efd5c345e8fa1bdc2a6d3ea4dd4b2eb5b9cc62/src/user-agent.ts#L20)
+Defined in: [user-agent.ts:20](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/user-agent.ts#L20)
 
 Device type (e.g., Mobile, Tablet, Desktop, Other).
 
@@ -36,7 +36,7 @@ Device type (e.g., Mobile, Tablet, Desktop, Other).
 
 > **engine**: `string`
 
-Defined in: [user-agent.ts:24](https://github.com/wtasg/node-lib/blob/b5efd5c345e8fa1bdc2a6d3ea4dd4b2eb5b9cc62/src/user-agent.ts#L24)
+Defined in: [user-agent.ts:24](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/user-agent.ts#L24)
 
 Rendering engine (e.g., Blink, WebKit, Gecko, Presto, Other).
 
@@ -46,7 +46,7 @@ Rendering engine (e.g., Blink, WebKit, Gecko, Presto, Other).
 
 > **os**: `string`
 
-Defined in: [user-agent.ts:16](https://github.com/wtasg/node-lib/blob/b5efd5c345e8fa1bdc2a6d3ea4dd4b2eb5b9cc62/src/user-agent.ts#L16)
+Defined in: [user-agent.ts:16](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/user-agent.ts#L16)
 
 Operating system (e.g., Windows, macOS, Linux, iOS, Android, Other).
 
@@ -56,6 +56,6 @@ Operating system (e.g., Windows, macOS, Linux, iOS, Android, Other).
 
 > **version**: `string`
 
-Defined in: [user-agent.ts:12](https://github.com/wtasg/node-lib/blob/b5efd5c345e8fa1bdc2a6d3ea4dd4b2eb5b9cc62/src/user-agent.ts#L12)
+Defined in: [user-agent.ts:12](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/user-agent.ts#L12)
 
 Browser version (e.g., 120.0.0.0).

package/docs/type-aliases/Base32CharsetType.md

@@ -0,0 +1,13 @@
+[**@wtasnorg/node-lib**](../README.md)
+
+***
+
+[@wtasnorg/node-lib](../README.md) / Base32CharsetType
+
+# Type Alias: Base32CharsetType
+
+> **Base32CharsetType** = *typeof* [`Base32Charset`](../variables/Base32Charset.md)\[`number`\]
+
+Defined in: [base32.ts:18](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/base32.ts#L18)
+
+Base32 charset type.

package/docs/type-aliases/Base58CharsetType.md

@@ -0,0 +1,13 @@
+[**@wtasnorg/node-lib**](../README.md)
+
+***
+
+[@wtasnorg/node-lib](../README.md) / Base58CharsetType
+
+# Type Alias: Base58CharsetType
+
+> **Base58CharsetType** = *typeof* [`Base58Charset`](../variables/Base58Charset.md)\[`number`\]
+
+Defined in: [base58.ts:18](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/base58.ts#L18)
+
+Base58 charset type.

package/docs/type-aliases/Base64CharsetType.md

@@ -8,6 +8,6 @@
 
 > **Base64CharsetType** = *typeof* [`Base64Charset`](../variables/Base64Charset.md)\[`number`\]
 
-Defined in: base64.ts:18
+Defined in: [base64.ts:18](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/base64.ts#L18)
 
 Base64 charset type.

package/docs/type-aliases/Base85CharsetType.md

@@ -0,0 +1,13 @@
+[**@wtasnorg/node-lib**](../README.md)
+
+***
+
+[@wtasnorg/node-lib](../README.md) / Base85CharsetType
+
+# Type Alias: Base85CharsetType
+
+> **Base85CharsetType** = *typeof* [`Base85Charset`](../variables/Base85Charset.md)\[`number`\]
+
+Defined in: [base85.ts:18](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/base85.ts#L18)
+
+Base85 charset type.

package/docs/variables/Base32Charset.md

@@ -0,0 +1,16 @@
+[**@wtasnorg/node-lib**](../README.md)
+
+***
+
+[@wtasnorg/node-lib](../README.md) / Base32Charset
+
+# Variable: Base32Charset
+
+> `const` **Base32Charset**: readonly \[`"rfc4648"`, `"hex"`, `"crockford"`\]
+
+Defined in: [base32.ts:13](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/base32.ts#L13)
+
+Available Base32 charset variants.
+- `rfc4648`: Standard RFC 4648 alphabet (A-Z, 2-7)
+- `hex`: Extended hex alphabet (0-9, A-V)
+- `crockford`: Douglas Crockford's alphabet (excludes I, L, O, U)

package/docs/variables/Base58Charset.md

@@ -0,0 +1,16 @@
+[**@wtasnorg/node-lib**](../README.md)
+
+***
+
+[@wtasnorg/node-lib](../README.md) / Base58Charset
+
+# Variable: Base58Charset
+
+> `const` **Base58Charset**: readonly \[`"bitcoin"`, `"flickr"`, `"ripple"`\]
+
+Defined in: [base58.ts:13](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/base58.ts#L13)
+
+Available Base58 charset variants.
+- `bitcoin`: Bitcoin/IPFS alphabet (default)
+- `flickr`: Flickr short URLs (swaps case)
+- `ripple`: Ripple addresses

package/docs/variables/Base64Charset.md

@@ -8,7 +8,7 @@
 
 > `const` **Base64Charset**: readonly \[`"standard"`, `"urlsafe"`, `"imap"`, `"radix64"`\]
 
-Defined in: base64.ts:13
+Defined in: [base64.ts:13](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/base64.ts#L13)
 
 Available Base64 charset variants.
 - `standard`: RFC 4648 standard alphabet (A-Z, a-z, 0-9, +, /)

package/docs/variables/Base85Charset.md

@@ -0,0 +1,16 @@
+[**@wtasnorg/node-lib**](../README.md)
+
+***
+
+[@wtasnorg/node-lib](../README.md) / Base85Charset
+
+# Variable: Base85Charset
+
+> `const` **Base85Charset**: readonly \[`"ascii85"`, `"z85"`, `"rfc1924"`\]
+
+Defined in: [base85.ts:13](https://github.com/wtasg/node-lib/blob/ed0a2138895c2801b9318149a6c6b3580f396289/src/base85.ts#L13)
+
+Available Base85 charset variants.
+- `ascii85`: Adobe Ascii85 (btoa format)
+- `z85`: ZeroMQ Base85 (no quotes or backslash)
+- `rfc1924`: RFC 1924 IPv6 encoding