@wtasnorg/node-lib 0.0.9 → 0.0.10

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/7baf8669b7042dca550ec8a4beb26526d3b538b4/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/7baf8669b7042dca550ec8a4beb26526d3b538b4/src/base64.ts#L119)
 
 Decode a Base64 string.
 

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/7baf8669b7042dca550ec8a4beb26526d3b538b4/src/base64.ts#L79)
 
 Encode a string to Base64.
 

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/7baf8669b7042dca550ec8a4beb26526d3b538b4/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/7baf8669b7042dca550ec8a4beb26526d3b538b4/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/7baf8669b7042dca550ec8a4beb26526d3b538b4/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/7baf8669b7042dca550ec8a4beb26526d3b538b4/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/7baf8669b7042dca550ec8a4beb26526d3b538b4/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/7baf8669b7042dca550ec8a4beb26526d3b538b4/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/7baf8669b7042dca550ec8a4beb26526d3b538b4/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/7baf8669b7042dca550ec8a4beb26526d3b538b4/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/7baf8669b7042dca550ec8a4beb26526d3b538b4/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/7baf8669b7042dca550ec8a4beb26526d3b538b4/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/7baf8669b7042dca550ec8a4beb26526d3b538b4/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/7baf8669b7042dca550ec8a4beb26526d3b538b4/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/7baf8669b7042dca550ec8a4beb26526d3b538b4/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/7baf8669b7042dca550ec8a4beb26526d3b538b4/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/7baf8669b7042dca550ec8a4beb26526d3b538b4/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/7baf8669b7042dca550ec8a4beb26526d3b538b4/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/7baf8669b7042dca550ec8a4beb26526d3b538b4/src/user-agent.ts#L12)
 
 Browser version (e.g., 120.0.0.0).

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/7baf8669b7042dca550ec8a4beb26526d3b538b4/src/base64.ts#L18)
 
 Base64 charset type.

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/7baf8669b7042dca550ec8a4beb26526d3b538b4/src/base64.ts#L13)
 
 Available Base64 charset variants.
 - `standard`: RFC 4648 standard alphabet (A-Z, a-z, 0-9, +, /)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wtasnorg/node-lib",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "description": "node library",
   "main": "src/index.js",
   "scripts": {
@@ -38,5 +38,6 @@
     "typedoc-plugin-markdown": "^4.9.0",
     "typescript": "^5.9.3",
     "typescript-eslint": "^8.48.1"
-  }
-}
+  },
+  "sideEffects": false
+}

package/src/hello.d.ts

@@ -1,8 +1,33 @@
 /**
  * A sample function that should work to test if lib is installed correctly.
  *
- * @returns hello message
+ * @param {Console?} konsole - optional console object to log the message
+ * @returns {Promise<string>} `hello from @wtasnorg/node-lib`
+ *
+ * @example
+ * ```ts
+ * import { hello } from "@wtasnorg/node-lib";
+ *
+ * async function main() {
+ *     const message = await hello(console);
+ *     console.log("Received message:", message);
+ * }
+ *
+ * main();
+ * ```
+ *
+ * @example
+ * ```ts
+ * import { hello } from "@wtasnorg/node-lib";
+ *
+ * async function main() {
+ *     const message = await hello();
+ *     // Do something with the message
+ * }
+ *
+ * main();
+ * ```
  */
-declare function hello(): Promise<string>;
+declare function hello(konsole?: Console): Promise<string>;
 export { hello };
 //# sourceMappingURL=hello.d.ts.map

package/src/hello.js

@@ -1,12 +1,37 @@
 /**
  * A sample function that should work to test if lib is installed correctly.
  *
- * @returns hello message
+ * @param {Console?} konsole - optional console object to log the message
+ * @returns {Promise<string>} `hello from @wtasnorg/node-lib`
+ *
+ * @example
+ * ```ts
+ * import { hello } from "@wtasnorg/node-lib";
+ *
+ * async function main() {
+ *     const message = await hello(console);
+ *     console.log("Received message:", message);
+ * }
+ *
+ * main();
+ * ```
+ *
+ * @example
+ * ```ts
+ * import { hello } from "@wtasnorg/node-lib";
+ *
+ * async function main() {
+ *     const message = await hello();
+ *     // Do something with the message
+ * }
+ *
+ * main();
+ * ```
  */
-async function hello() {
+async function hello(konsole) {
     const message = "hello from @wtasnorg/node-lib";
-    if (console?.log) {
-        console.log(message);
+    if (konsole?.log) {
+        konsole.log(message);
     }
     return message;
 }

package/src/hello.test.js

@@ -12,5 +12,16 @@ describe("hello", () => {
         const actual = await hello();
         strictEqual(actual, expected);
     });
+    it("logs message when console is provided", async () => {
+        const spyConsole = {
+            logCalledWith: "",
+            log(message) {
+                this.logCalledWith = message;
+            }
+        };
+        const expectedMessage = "hello from @wtasnorg/node-lib";
+        await hello(spyConsole);
+        strictEqual(spyConsole.logCalledWith, expectedMessage);
+    });
 });
 //# sourceMappingURL=hello.test.js.map

package/src/hello.test.ts

@@ -14,4 +14,17 @@ describe("hello", () => {
         const actual = await hello();
         strictEqual(actual, expected);
     });
+
+    it("logs message when console is provided", async () => {
+        const spyConsole = {
+            logCalledWith: "",
+            log(message: string) {
+                this.logCalledWith = message;
+            }
+        };
+
+        const expectedMessage = "hello from @wtasnorg/node-lib";
+        await hello(spyConsole as unknown as Console);
+        strictEqual(spyConsole.logCalledWith, expectedMessage);
+    });
 });

package/src/hello.ts

@@ -1,12 +1,37 @@
 /**
  * A sample function that should work to test if lib is installed correctly.
  *
- * @returns hello message
+ * @param {Console?} konsole - optional console object to log the message
+ * @returns {Promise<string>} `hello from @wtasnorg/node-lib`
+ *
+ * @example
+ * ```ts
+ * import { hello } from "@wtasnorg/node-lib";
+ *
+ * async function main() {
+ *     const message = await hello(console);
+ *     console.log("Received message:", message);
+ * }
+ *
+ * main();
+ * ```
+ *
+ * @example
+ * ```ts
+ * import { hello } from "@wtasnorg/node-lib";
+ *
+ * async function main() {
+ *     const message = await hello();
+ *     // Do something with the message
+ * }
+ *
+ * main();
+ * ```
  */
-async function hello() {
+async function hello(konsole?: Console): Promise<string> {
     const message = "hello from @wtasnorg/node-lib";
-    if (console?.log) {
-        console.log(message);
+    if (konsole?.log) {
+        konsole.log(message);
     }
     return message;
 }