@kikiutils/shared 18.0.1 → 18.1.0

package/src/classes/precision-number.ts

@@ -6,36 +6,41 @@ import { Decimal } from 'decimal.js';
 export type PrecisionNumberValue = Decimal.Value | PrecisionNumber | { toString: () => string };
 
 /**
- * Chainable fixed-decimal wrapper around `decimal.js`.
+ * A fixed-decimal number with mutable and immutable arithmetic operations.
  *
+ * @remarks
  * `PrecisionNumber` stores values as `Decimal`, rounds every mutating operation to
  * the configured decimal places, and exposes both mutable and immutable arithmetic
  * methods. Mutable methods (`plus`, `minus`, `times`, `dividedBy`, `modulo`,
  * `pow`, `clamp`, `ceil`, `floor`, `negate`, `absoluteValue`) update the current
  * instance and return `this`; immutable methods prefixed with `to` return a new
- * `PrecisionNumber` with the same precision settings.
+ * `PrecisionNumber` with the same precision settings, leaving this instance unchanged.
+ * Decimal.js exceptions propagate unchanged; non-finite arithmetic results are not converted into exceptions.
  *
  * @example
- * ```typescript
+ *
+ * ```ts
  * import { PrecisionNumber } from '@kikiutils/shared/classes/precision-number';
  *
  * const value = new PrecisionNumber('1.239', 2).plus('2.111');
- * value.toString(); // '3.35'
- * value.toMinus('1').toString(); // '2.35' (original value remains '3.35')
+ * value.toString(); // => '3.35'
+ * value.toMinus('1').toString(); // => '2.35' (original value remains '3.35')
  * ```
  */
 export class PrecisionNumber {
-    // Private properties
+    // Private instance properties
     readonly #decimalPlaces: number;
     readonly #rounding: Decimal.Rounding;
     #decimal: Decimal;
 
+    // Constructor
+
     /**
      * Creates a fixed-decimal number.
      *
-     * @param {PrecisionNumberValue} [value] - Initial value (default: `'0'`)
-     * @param {number} [decimalPlaces] - Decimal places retained after operations (default: `2`)
-     * @param {Decimal.Rounding} [rounding] - Decimal.js rounding mode (default: `Decimal.ROUND_DOWN`)
+     * @param value - Initial value (default: `'0'`).
+     * @param decimalPlaces - Decimal places retained after operations (default: `2`).
+     * @param rounding - Decimal.js rounding mode (default: `Decimal.ROUND_DOWN`).
      */
     constructor(
         value: PrecisionNumberValue = '0',
@@ -47,26 +52,7 @@ export class PrecisionNumber {
         this.#decimal = this.#decimalToFixedDecimal(new Decimal(value.toString().trim()));
     }
 
-    // Symbols
-
-    /**
-     * Returns the formatted value when inspected by Node.js utilities.
-     */
-    [Symbol.for('nodejs.util.inspect.custom')]() {
-        return this.value;
-    }
-
-    /**
-     * Converts to a number for numeric coercion and to the fixed string otherwise.
-     *
-     * @param {string} hint - JavaScript primitive-conversion hint
-     */
-    [Symbol.toPrimitive](hint: string) {
-        if (hint === 'number') return this.#decimal.toNumber();
-        return this.value;
-    }
-
-    // Private methods
+    // Private instance methods
     #decimalToFixedDecimal(decimal: Decimal) {
         return decimal.toDecimalPlaces(this.#decimalPlaces, this.#rounding);
     }
@@ -75,7 +61,7 @@ export class PrecisionNumber {
         return value.toString().trim();
     }
 
-    // Public getters
+    // Public instance accessors
 
     /**
      * Decimal places retained by mutating operations and default formatting.
@@ -98,14 +84,16 @@ export class PrecisionNumber {
         return this.#decimal.toFixed(this.#decimalPlaces, this.#rounding);
     }
 
+    // Public static methods
+
     /**
      * Formats a value with decimal.js without creating a reusable instance.
      *
-     * @param {PrecisionNumberValue} value - Value to format
-     * @param {number} [decimalPlaces] - Decimal places to output (default: `2`)
-     * @param {Decimal.Rounding} [rounding] - Decimal.js rounding mode (default: `Decimal.ROUND_DOWN`)
+     * @param value - Value to format.
+     * @param decimalPlaces - Decimal places to output (default: `2`).
+     * @param rounding - Decimal.js rounding mode (default: `Decimal.ROUND_DOWN`).
      *
-     * @returns {string} Fixed-decimal string
+     * @returns Fixed-decimal string.
      */
     static toFixed(
         value: PrecisionNumberValue,
@@ -115,12 +103,29 @@ export class PrecisionNumber {
         return new Decimal(value.toString().trim()).toFixed(decimalPlaces, rounding);
     }
 
-    // Public methods
+    // Public instance methods
+
+    /**
+     * Returns the formatted value when inspected by Node.js utilities.
+     */
+    [Symbol.for('nodejs.util.inspect.custom')]() {
+        return this.value;
+    }
+
+    /**
+     * Converts to a number for numeric coercion and to the fixed string otherwise.
+     *
+     * @param hint - JavaScript primitive-conversion hint.
+     */
+    [Symbol.toPrimitive](hint: string) {
+        if (hint === 'number') return this.#decimal.toNumber();
+        return this.value;
+    }
 
     /**
      * Replaces the current value with its absolute value.
      *
-     * @returns {this} The current instance for chaining
+     * @returns This instance for chaining.
      */
     absoluteValue() {
         this.#decimal = this.#decimalToFixedDecimal(this.#decimal.absoluteValue());
@@ -130,9 +135,10 @@ export class PrecisionNumber {
     /**
      * Rounds the current value up to the nearest integer in place.
      *
+     * @remarks
      * The stored value still uses this instance's configured decimal places for output.
      *
-     * @returns {this} The current instance for chaining
+     * @returns This instance for chaining.
      */
     ceil() {
         this.#decimal = this.#decimalToFixedDecimal(this.#decimal.ceil());
@@ -142,12 +148,12 @@ export class PrecisionNumber {
     /**
      * Restricts the current value to the inclusive range `[min, max]` in place.
      *
-     * @param {PrecisionNumberValue} min - Lower bound
-     * @param {PrecisionNumberValue} max - Upper bound
+     * @param min - Lower bound.
+     * @param max - Upper bound.
      *
-     * @returns {this} The current instance for chaining
+     * @returns This instance for chaining.
      *
-     * @throws {Error} If `min` is greater than `max`
+     * @throws Error if `min` is greater than `max`.
      */
     clamp(min: PrecisionNumberValue, max: PrecisionNumberValue) {
         const minDecimal = new Decimal(this.#valueToString(min));
@@ -167,9 +173,9 @@ export class PrecisionNumber {
     /**
      * Divides the current value by another value in place.
      *
-     * @param {PrecisionNumberValue} value - Divisor
+     * @param value - Divisor.
      *
-     * @returns {this} The current instance for chaining
+     * @returns This instance for chaining.
      */
     dividedBy(value: PrecisionNumberValue) {
         this.#decimal = this.#decimalToFixedDecimal(this.#decimal.dividedBy(this.#valueToString(value)));
@@ -179,9 +185,9 @@ export class PrecisionNumber {
     /**
      * Checks whether the current value equals another value.
      *
-     * @param {PrecisionNumberValue} value - Value to compare
+     * @param value - Value to compare.
      *
-     * @returns {boolean} `true` when both numeric values are equal
+     * @returns Whether both numeric values are equal.
      */
     equals(value: PrecisionNumberValue) {
         return this.#decimal.equals(this.#valueToString(value));
@@ -190,9 +196,10 @@ export class PrecisionNumber {
     /**
      * Rounds the current value down to the nearest integer in place.
      *
+     * @remarks
      * The stored value still uses this instance's configured decimal places for output.
      *
-     * @returns {this} The current instance for chaining
+     * @returns This instance for chaining.
      */
     floor() {
         this.#decimal = this.#decimalToFixedDecimal(this.#decimal.floor());
@@ -280,9 +287,9 @@ export class PrecisionNumber {
     /**
      * Replaces the current value with the remainder after division by another value.
      *
-     * @param {PrecisionNumberValue} value - Divisor used to compute the remainder
+     * @param value - Divisor used to compute the remainder.
      *
-     * @returns {this} The current instance for chaining
+     * @returns This instance for chaining.
      */
     modulo(value: PrecisionNumberValue) {
         this.#decimal = this.#decimalToFixedDecimal(this.#decimal.modulo(this.#valueToString(value)));
@@ -308,9 +315,9 @@ export class PrecisionNumber {
     /**
      * Raises the current value to an exponent in place.
      *
-     * @param {PrecisionNumberValue} value - Exponent
+     * @param value - Exponent.
      *
-     * @returns {this} The current instance for chaining
+     * @returns This instance for chaining.
      */
     pow(value: PrecisionNumberValue) {
         this.#decimal = this.#decimalToFixedDecimal(this.#decimal.pow(this.#valueToString(value)));
@@ -342,10 +349,10 @@ export class PrecisionNumber {
     /**
      * Returns a new instance restricted to the inclusive range `[min, max]`.
      *
-     * @param {PrecisionNumberValue} min - Lower bound
-     * @param {PrecisionNumberValue} max - Upper bound
+     * @param min - Lower bound.
+     * @param max - Upper bound.
      *
-     * @throws {Error} If `min` is greater than `max`
+     * @throws Error if `min` is greater than `max`.
      */
     toClamped(min: PrecisionNumberValue, max: PrecisionNumberValue) {
         return this.clone().clamp(min, max);
@@ -422,6 +429,7 @@ export class PrecisionNumber {
     /**
      * Converts the current value to a JavaScript number.
      *
+     * @remarks
      * Use `toString`/`value` when preserving decimal precision is more important than native-number ergonomics.
      */
     toNumber() {

package/src/classes/ssh-client.ts

@@ -27,11 +27,16 @@ const loggerLevelStringToConsolaLogLevelMap = {
 } as const;
 
 export class SshClient {
+    // Private instance properties
     readonly #connectConfig: Config;
     readonly #logger: ConsolaInstance;
-
     #nodeSsh: NodeSSH;
 
+    // Public instance properties
+    getDir = this.getDirectory;
+    putDir = this.putDirectory;
+
+    // Constructor
     constructor(host: string, username: string, password: string, port: number = 22, connectConfig?: Config) {
         this.#connectConfig = {
             ...connectConfig,
@@ -46,10 +51,12 @@ export class SshClient {
         if (process.env.NODE_ENV === 'production') this.setLoggerLevel('error');
     }
 
+    // Public instance accessors
     get nodeSsh() {
         return this.#nodeSsh;
     }
 
+    // Public instance methods
     async connect() {
         try {
             this.#nodeSsh = await this.#nodeSsh.connect(this.#connectConfig);
@@ -85,8 +92,6 @@ export class SshClient {
         );
     }
 
-    getDir = this.getDirectory;
-
     async getDirectory(localDirectory: PathLike, remoteDirectory: PathLike, options?: SSHGetPutDirectoryOptions) {
         try {
             return await this.#nodeSsh.getDirectory(localDirectory.toString(), remoteDirectory.toString(), options);
@@ -125,8 +130,6 @@ export class SshClient {
         }
     }
 
-    putDir = this.putDirectory;
-
     async putDirectory(localDirectory: PathLike, remoteDirectory: PathLike, options?: SSHGetPutDirectoryOptions) {
         try {
             return await this.#nodeSsh.putDirectory(localDirectory.toString(), remoteDirectory.toString(), options);

package/src/clipboard.ts

@@ -3,28 +3,28 @@ type CopyResult =
   | { ok: true };
 
 /**
- * Attempts to copy a Blob (e.g. image, plain text, HTML) to the user's clipboard using the ClipboardItem API.
+ * Attempts to copy a blob to the browser clipboard.
  *
- * ⚠️ Usage Notes:
- * - Must be called in a **secure context** (HTTPS or localhost).
- * - Must be called **in response to a user interaction** (e.g. click, input).
- * - Not supported in Safari and some older browsers.
+ * @remarks
+ * Requires a browser environment with clipboard support, a secure context, and any user activation required
+ * by the browser. Clipboard API failures are returned as results rather than rethrown.
  *
- * @param {Blob} blob - The Blob object to copy (e.g. from a File, image, or text content)
- * @param {ClipboardItemOptions} [options] - Optional options passed to the ClipboardItem constructor
+ * @param blob - The blob whose MIME type identifies the clipboard format.
+ * @param options - Options passed to the `ClipboardItem` constructor.
  *
- * @returns {Promise<CopyResult>} A promise resolving to a `CopyResult`:
- *   - `{ ok: true }` if the copy succeeded
- *   - `{ ok: false, error }` if the copy failed, with the error included
+ * @returns A promise resolving after the copy attempt to `{ ok: true }` on success, or
+ * `{ ok: false, error }` with the failure reason.
  *
  * @example
- * ```typescript
+ *
+ * ```ts
  * import { copyBlobToClipboard } from '@kikiutils/shared/clipboard';
  *
+ * // Call from a user interaction in a supported browser.
  * const blob = new Blob(['Hello world'], { type: 'text/plain' });
  * const result = await copyBlobToClipboard(blob);
  * if (result.ok) {
- *     console.log('Copied blob!');
+ *     console.log('Copied!');
  * } else {
  *     console.error('Copy failed:', result.error);
  * }
@@ -51,24 +51,24 @@ export async function copyBlobToClipboard(blob: Blob, options?: ClipboardItemOpt
 }
 
 /**
- * Attempts to copy the given text to the user's clipboard using the modern Clipboard API.
+ * Attempts to copy text to the browser clipboard.
  *
- * ⚠️ Usage Notes:
- * - Must be called in a **secure context** (HTTPS or localhost).
- * - Must be called **in response to a user interaction** (e.g. click, input).
- * - Not supported in some older browsers (especially legacy Safari).
+ * @remarks
+ * Requires a browser environment with clipboard support, a secure context, and any user activation required
+ * by the browser. Clipboard API failures are returned as results rather than rethrown.
  *
- * @param {string} text - The string to be copied to the clipboard
+ * @param text - The text to copy.
  *
- * @returns {Promise<CopyResult>} A promise resolving to a `CopyResult`:
- *   - `{ ok: true }` if the copy succeeded
- *   - `{ ok: false, error }` if the copy failed, with the error included
+ * @returns A promise resolving after the copy attempt to `{ ok: true }` on success, or
+ * `{ ok: false, error }` with the failure reason.
  *
  * @example
- * ```typescript
+ *
+ * ```ts
  * import { copyTextToClipboard } from '@kikiutils/shared/clipboard';
  *
- * const result = await copyTextToClipboard('Hello!');
+ * // Call from a user interaction in a supported browser.
+ * const result = await copyTextToClipboard('Hello world');
  * if (result.ok) {
  *     console.log('Copied!');
  * } else {

package/src/consola.ts

@@ -1,25 +1,23 @@
 import { createConsola } from 'consola';
 
 /**
- * A consola logger instance.
+ * A consola logger with environment-controlled verbosity.
  *
- * The logger's level is determined based on the `CONSOLA_LOGGER_LEVEL` and `NODE_ENV` environment variables.
- * If `CONSOLA_LOGGER_LEVEL` is set, it will be used; otherwise, if `NODE_ENV` is `production`,
- * the level will be set to `0`.
- *
- * To manually change the level, assign the desired level to `logger.level`.
- *
- * See available levels [here](https://github.com/unjs/consola?tab=readme-ov-file#log-level).
+ * @remarks
+ * `CONSOLA_LOGGER_LEVEL` sets the log level when defined at module initialization;
+ * otherwise, `NODE_ENV=production` selects `0`, and other environments retain the logger's default level.
+ * Assign `logger.level` to change verbosity after initialization.
  *
  * @example
- * ```typescript
- * import { logger } from '@kikiutils/shared/consola';
  *
- * logger.info('test'); // ℹ test 3:56:30 AM
+ * ```ts
+ * import { logger } from '@kikiutils/shared/consola';
  *
- * // Manually change the level
  * logger.level = 3;
+ * logger.info('Application started');
  * ```
+ *
+ * @see {@link https://github.com/unjs/consola#log-level | Consola log levels}
  */
 export const consolaLogger = createConsola();
 export const logger = consolaLogger;

package/src/crypto-hash.ts

@@ -5,16 +5,17 @@ import type { BinaryLike } from 'node:crypto';
 /**
  * Computes the MD5 hash of the given data.
  *
- * @param {BinaryLike} data - The input data to hash
- * @param {BufferEncoding} [outputEncoding] - The output encoding (default: `'hex'`)
+ * @param data - The input data to hash.
+ * @param outputEncoding - The output encoding. Defaults to `hex`.
  *
- * @returns {string | Buffer} The hash digest in the specified encoding
+ * @returns The hash digest in the specified encoding.
  *
  * @example
- * ```typescript
+ *
+ * ```ts
  * import { cryptoMd5 } from '@kikiutils/shared/crypto-hash';
  *
- * console.log(cryptoMd5('test')); // 098f6bcd4621d373cade4e832627b4f6
+ * console.log(cryptoMd5('test')); // => 098f6bcd4621d373cade4e832627b4f6
  * ```
  */
 export function cryptoMd5(data: BinaryLike, outputEncoding: BufferEncoding = 'hex') {
@@ -24,15 +25,16 @@ export function cryptoMd5(data: BinaryLike, outputEncoding: BufferEncoding = 'he
 /**
  * Computes the MD5 hash of the given data and returns the raw buffer.
  *
- * @param {BinaryLike} data - The input data to hash
+ * @param data - The input data to hash.
  *
- * @returns {Buffer} The raw hash digest as a Buffer
+ * @returns A new `Buffer` containing the raw hash digest.
  *
  * @example
- * ```typescript
+ *
+ * ```ts
  * import { cryptoMd5ToBuffer } from '@kikiutils/shared/crypto-hash';
  *
- * console.log(cryptoMd5ToBuffer('test')); // <Buffer 33 ed 9a ...>
+ * console.log(cryptoMd5ToBuffer('test')); // => <Buffer 09 8f 6b cd ...>
  * ```
  */
 export function cryptoMd5ToBuffer(data: BinaryLike) {
@@ -42,16 +44,17 @@ export function cryptoMd5ToBuffer(data: BinaryLike) {
 /**
  * Computes the SHA-3 hash of the given data using the 224-bit digest.
  *
- * @param {BinaryLike} data - The input data to hash
- * @param {BufferEncoding} [outputEncoding] - The output encoding (default: `'hex'`)
+ * @param data - The input data to hash.
+ * @param outputEncoding - The output encoding. Defaults to `hex`.
  *
- * @returns {string | Buffer} The hash digest in the specified encoding
+ * @returns The hash digest in the specified encoding.
  *
  * @example
- * ```typescript
+ *
+ * ```ts
  * import { cryptoSha3224 } from '@kikiutils/shared/crypto-hash';
  *
- * console.log(cryptoSha3224('test')); // 3797bf0afbbfca4a7bbba7602a2b552746876517a7f9b7ce2db0ae7b
+ * console.log(cryptoSha3224('test')); // => 3797bf0afbbfca4a7bbba7602a2b552746876517a7f9b7ce2db0ae7b
  * ```
  */
 export function cryptoSha3224(data: BinaryLike, outputEncoding: BufferEncoding = 'hex') {
@@ -61,15 +64,16 @@ export function cryptoSha3224(data: BinaryLike, outputEncoding: BufferEncoding =
 /**
  * Computes the SHA-3 hash of the given data using the 224-bit digest and returns the raw buffer.
  *
- * @param {BinaryLike} data - The input data to hash
+ * @param data - The input data to hash.
  *
- * @returns {Buffer} The raw hash digest as a Buffer
+ * @returns A new `Buffer` containing the raw hash digest.
  *
  * @example
- * ```typescript
+ *
+ * ```ts
  * import { cryptoSha3224ToBuffer } from '@kikiutils/shared/crypto-hash';
  *
- * console.log(cryptoSha3224ToBuffer('test')); // <Buffer 37 97 bf 0a ...>
+ * console.log(cryptoSha3224ToBuffer('test')); // => <Buffer 37 97 bf 0a ...>
  * ```
  */
 export function cryptoSha3224ToBuffer(data: BinaryLike) {
@@ -79,16 +83,17 @@ export function cryptoSha3224ToBuffer(data: BinaryLike) {
 /**
  * Computes the SHA-3 hash of the given data using the 256-bit digest.
  *
- * @param {BinaryLike} data - The input data to hash
- * @param {BufferEncoding} [outputEncoding] - The output encoding (default: `'hex'`)
+ * @param data - The input data to hash.
+ * @param outputEncoding - The output encoding. Defaults to `hex`.
  *
- * @returns {string | Buffer} The hash digest in the specified encoding
+ * @returns The hash digest in the specified encoding.
  *
  * @example
- * ```typescript
+ *
+ * ```ts
  * import { cryptoSha3256 } from '@kikiutils/shared/crypto-hash';
  *
- * console.log(cryptoSha3256('test')); // 36f028580bb02cc8272a9a020f4200e346e276ae664e45ee80745574e2f5ab80
+ * console.log(cryptoSha3256('test')); // => 36f028580bb02cc8272a9a020f4200e346e276ae664e45ee80745574e2f5ab80
  * ```
  */
 export function cryptoSha3256(data: BinaryLike, outputEncoding: BufferEncoding = 'hex') {
@@ -98,15 +103,16 @@ export function cryptoSha3256(data: BinaryLike, outputEncoding: BufferEncoding =
 /**
  * Computes the SHA-3 hash of the given data using the 256-bit digest and returns the raw buffer.
  *
- * @param {BinaryLike} data - The input data to hash
+ * @param data - The input data to hash.
  *
- * @returns {Buffer} The raw hash digest as a Buffer
+ * @returns A new `Buffer` containing the raw hash digest.
  *
  * @example
- * ```typescript
+ *
+ * ```ts
  * import { cryptoSha3256ToBuffer } from '@kikiutils/shared/crypto-hash';
  *
- * console.log(cryptoSha3256ToBuffer('test')); // <Buffer 36 f0 28 ...>
+ * console.log(cryptoSha3256ToBuffer('test')); // => <Buffer 36 f0 28 ...>
  * ```
  */
 export function cryptoSha3256ToBuffer(data: BinaryLike) {
@@ -116,16 +122,17 @@ export function cryptoSha3256ToBuffer(data: BinaryLike) {
 /**
  * Computes the SHA-3 hash of the given data using the 384-bit digest.
  *
- * @param {BinaryLike} data - The input data to hash
- * @param {BufferEncoding} [outputEncoding] - The output encoding (default: `'hex'`)
+ * @param data - The input data to hash.
+ * @param outputEncoding - The output encoding. Defaults to `hex`.
  *
- * @returns {string | Buffer} The hash digest in the specified encoding
+ * @returns The hash digest in the specified encoding.
  *
  * @example
- * ```typescript
+ *
+ * ```ts
  * import { cryptoSha3384 } from '@kikiutils/shared/crypto-hash';
  *
- * console.log(cryptoSha3384('test')); // e516dabb23b6e30026863543282780a3ae0dccf05551cf0295178d7f...
+ * console.log(cryptoSha3384('test')); // => e516dabb23b6e30026863543282780a3ae0dccf05551cf0295178d7f...
  * ```
  */
 export function cryptoSha3384(data: BinaryLike, outputEncoding: BufferEncoding = 'hex') {
@@ -135,15 +142,16 @@ export function cryptoSha3384(data: BinaryLike, outputEncoding: BufferEncoding =
 /**
  * Computes the SHA-3 hash of the given data using the 384-bit digest and returns the raw buffer.
  *
- * @param {BinaryLike} data - The input data to hash
+ * @param data - The input data to hash.
  *
- * @returns {Buffer} The raw hash digest as a Buffer
+ * @returns A new `Buffer` containing the raw hash digest.
  *
  * @example
- * ```typescript
+ *
+ * ```ts
  * import { cryptoSha3384ToBuffer } from '@kikiutils/shared/crypto-hash';
  *
- * console.log(cryptoSha3384ToBuffer('test')); // <Buffer e5 16 da bb ...>
+ * console.log(cryptoSha3384ToBuffer('test')); // => <Buffer e5 16 da bb ...>
  * ```
  */
 export function cryptoSha3384ToBuffer(data: BinaryLike) {
@@ -153,16 +161,17 @@ export function cryptoSha3384ToBuffer(data: BinaryLike) {
 /**
  * Computes the SHA-3 hash of the given data using the 512-bit digest.
  *
- * @param {BinaryLike} data - The input data to hash
- * @param {BufferEncoding} [outputEncoding] - The output encoding (default: `'hex'`)
+ * @param data - The input data to hash.
+ * @param outputEncoding - The output encoding. Defaults to `hex`.
  *
- * @returns {string | Buffer} The hash digest in the specified encoding
+ * @returns The hash digest in the specified encoding.
  *
  * @example
- * ```typescript
+ *
+ * ```ts
  * import { cryptoSha3512 } from '@kikiutils/shared/crypto-hash';
  *
- * console.log(cryptoSha3512('test')); // 9ece086e9bac491fac5c1d1046ca11d737b92a2b2ebd93f005d7...
+ * console.log(cryptoSha3512('test')); // => 9ece086e9bac491fac5c1d1046ca11d737b92a2b2ebd93f005d7...
  * ```
  */
 export function cryptoSha3512(data: BinaryLike, outputEncoding: BufferEncoding = 'hex') {
@@ -172,15 +181,16 @@ export function cryptoSha3512(data: BinaryLike, outputEncoding: BufferEncoding =
 /**
  * Computes the SHA-3 hash of the given data using the 512-bit digest and returns the raw buffer.
  *
- * @param {BinaryLike} data - The input data to hash
+ * @param data - The input data to hash.
  *
- * @returns {Buffer} The raw hash digest as a Buffer
+ * @returns A new `Buffer` containing the raw hash digest.
  *
  * @example
- * ```typescript
+ *
+ * ```ts
  * import { cryptoSha3512ToBuffer } from '@kikiutils/shared/crypto-hash';
  *
- * console.log(cryptoSha3512ToBuffer('test')); // <Buffer 9e ce 08 6e ...>
+ * console.log(cryptoSha3512ToBuffer('test')); // => <Buffer 9e ce 08 6e ...>
  * ```
  */
 export function cryptoSha3512ToBuffer(data: BinaryLike) {