@ls-stack/utils 3.24.1 → 3.25.0

package/lib/retryOnError.d.ts

@@ -18,6 +18,8 @@ type RetryOptions = {
  * @param fn - Function to retry that receives context with retry count
  * @param maxRetries - Maximum number of retries
  * @param options - Configuration options
+ * @param retry
+ * @param originalMaxRetries
  * @returns Promise resolving to the function result or rejecting with the final error
  *
  * @example

package/lib/runShellCmd.d.cts

@@ -13,6 +13,14 @@ type RunCmdOptions = {
     noCiColorForce?: boolean;
 };
 /**
+ * @param label
+ * @param command
+ * @param root0
+ * @param root0.mock
+ * @param root0.silent
+ * @param root0.throwOnError
+ * @param root0.cwd
+ * @param root0.noCiColorForce
  * @deprecated This utility has been moved to @ls-stack/node-utils. Please update your imports:
  * ```
  * // Old (deprecated)
@@ -24,6 +32,9 @@ type RunCmdOptions = {
  */
 declare function runCmd(label: string | null, command: string | string[], { mock, silent, throwOnError, cwd, noCiColorForce, }?: RunCmdOptions): Promise<CmdResult>;
 /**
+ * @param label
+ * @param cmd
+ * @param onResult
  * @deprecated This utility has been moved to @ls-stack/node-utils. Please update your imports:
  * ```
  * // Old (deprecated)
@@ -35,6 +46,10 @@ declare function runCmd(label: string | null, command: string | string[], { mock
  */
 declare function concurrentCmd(label: string, cmd: string | string[], onResult: (result: CmdResult) => void): Promise<() => void>;
 /**
+ * @param label
+ * @param command
+ * @param root0
+ * @param root0.silent
  * @deprecated This utility has been moved to @ls-stack/node-utils. Please update your imports:
  * ```
  * // Old (deprecated)
@@ -48,6 +63,7 @@ declare function runCmdUnwrap(label: string | null, command: string | string[],
     silent?: boolean | 'timeOnly';
 }): Promise<string>;
 /**
+ * @param command
  * @deprecated This utility has been moved to @ls-stack/node-utils. Please update your imports:
  * ```
  * // Old (deprecated)
@@ -59,6 +75,7 @@ declare function runCmdUnwrap(label: string | null, command: string | string[],
  */
 declare function runCmdSilent(command: string | string[]): Promise<CmdResult>;
 /**
+ * @param command
  * @deprecated This utility has been moved to @ls-stack/node-utils. Please update your imports:
  * ```
  * // Old (deprecated)

package/lib/runShellCmd.d.ts

@@ -13,6 +13,14 @@ type RunCmdOptions = {
     noCiColorForce?: boolean;
 };
 /**
+ * @param label
+ * @param command
+ * @param root0
+ * @param root0.mock
+ * @param root0.silent
+ * @param root0.throwOnError
+ * @param root0.cwd
+ * @param root0.noCiColorForce
  * @deprecated This utility has been moved to @ls-stack/node-utils. Please update your imports:
  * ```
  * // Old (deprecated)
@@ -24,6 +32,9 @@ type RunCmdOptions = {
  */
 declare function runCmd(label: string | null, command: string | string[], { mock, silent, throwOnError, cwd, noCiColorForce, }?: RunCmdOptions): Promise<CmdResult>;
 /**
+ * @param label
+ * @param cmd
+ * @param onResult
  * @deprecated This utility has been moved to @ls-stack/node-utils. Please update your imports:
  * ```
  * // Old (deprecated)
@@ -35,6 +46,10 @@ declare function runCmd(label: string | null, command: string | string[], { mock
  */
 declare function concurrentCmd(label: string, cmd: string | string[], onResult: (result: CmdResult) => void): Promise<() => void>;
 /**
+ * @param label
+ * @param command
+ * @param root0
+ * @param root0.silent
  * @deprecated This utility has been moved to @ls-stack/node-utils. Please update your imports:
  * ```
  * // Old (deprecated)
@@ -48,6 +63,7 @@ declare function runCmdUnwrap(label: string | null, command: string | string[],
     silent?: boolean | 'timeOnly';
 }): Promise<string>;
 /**
+ * @param command
  * @deprecated This utility has been moved to @ls-stack/node-utils. Please update your imports:
  * ```
  * // Old (deprecated)
@@ -59,6 +75,7 @@ declare function runCmdUnwrap(label: string | null, command: string | string[],
  */
 declare function runCmdSilent(command: string | string[]): Promise<CmdResult>;
 /**
+ * @param command
  * @deprecated This utility has been moved to @ls-stack/node-utils. Please update your imports:
  * ```
  * // Old (deprecated)

package/lib/safeJson.d.cts

@@ -1,6 +1,12 @@
-/** JSON.stringify can throw if the value is circular or contains functions, this function catches those errors and returns undefined */
+/**
+ * JSON.stringify can throw if the value is circular or contains functions, this function catches those errors and returns undefined
+ * @param value
+ */
 declare function safeJsonStringify(value: unknown): string | undefined;
-/** JSON.parse can throw if the value is not valid JSON, this function catches those errors and returns undefined */
+/**
+ * JSON.parse can throw if the value is not valid JSON, this function catches those errors and returns undefined
+ * @param value
+ */
 declare function safeJsonParse(value: string): unknown;
 
 export { safeJsonParse, safeJsonStringify };

package/lib/safeJson.d.ts

@@ -1,6 +1,12 @@
-/** JSON.stringify can throw if the value is circular or contains functions, this function catches those errors and returns undefined */
+/**
+ * JSON.stringify can throw if the value is circular or contains functions, this function catches those errors and returns undefined
+ * @param value
+ */
 declare function safeJsonStringify(value: unknown): string | undefined;
-/** JSON.parse can throw if the value is not valid JSON, this function catches those errors and returns undefined */
+/**
+ * JSON.parse can throw if the value is not valid JSON, this function catches those errors and returns undefined
+ * @param value
+ */
 declare function safeJsonParse(value: string): unknown;
 
 export { safeJsonParse, safeJsonStringify };

package/lib/saferTyping.d.cts

@@ -8,12 +8,14 @@ type EmptyObject = Record<string, never>;
 /**
  * Cast a value to `any` type. Use this when you have legit usage of `any` casting.
  *
+ * @param value
  * @template V (optional) - When used enforces that the casted value is assignable to the type V, use it for safer casts
  */
 declare function __LEGIT_ANY_CAST__<V = unknown>(value: V): __LEGIT_ANY__;
 /**
  * Cast a value to a specific type T. Use this when you have legit usage of type assertion.
  *
+ * @param value
  * @template T - The type to cast to
  * @template V (optional) - When used enforces that the casted value is assignable to the type V, use it for safer casts
  */
@@ -21,6 +23,7 @@ declare function __LEGIT_CAST__<T, V = unknown>(value: V): T;
 /**
  * Refine a value to a specific type T. Use this when you have legit usage of type assertion.
  *
+ * @param value
  * @template T - The type to cast to
  * @template V (optional) - When used enforces that the casted value is assignable to the type V, use it for safer casts
  */

package/lib/saferTyping.d.ts

@@ -8,12 +8,14 @@ type EmptyObject = Record<string, never>;
 /**
  * Cast a value to `any` type. Use this when you have legit usage of `any` casting.
  *
+ * @param value
  * @template V (optional) - When used enforces that the casted value is assignable to the type V, use it for safer casts
  */
 declare function __LEGIT_ANY_CAST__<V = unknown>(value: V): __LEGIT_ANY__;
 /**
  * Cast a value to a specific type T. Use this when you have legit usage of type assertion.
  *
+ * @param value
  * @template T - The type to cast to
  * @template V (optional) - When used enforces that the casted value is assignable to the type V, use it for safer casts
  */
@@ -21,6 +23,7 @@ declare function __LEGIT_CAST__<T, V = unknown>(value: V): T;
 /**
  * Refine a value to a specific type T. Use this when you have legit usage of type assertion.
  *
+ * @param value
  * @template T - The type to cast to
  * @template V (optional) - When used enforces that the casted value is assignable to the type V, use it for safer casts
  */

package/lib/stringUtils.d.cts

@@ -2,6 +2,7 @@ type Arg = string | false | undefined | null;
 /**
  * A util to create more legible conditional concatenated strings
  *
+ * @param args
  * @example
  * joinStrings('a', 'b', 'c') // 'abc'
  * joinStrings('a', false, 'c') // 'ac'

package/lib/stringUtils.d.ts

@@ -2,6 +2,7 @@ type Arg = string | false | undefined | null;
 /**
  * A util to create more legible conditional concatenated strings
  *
+ * @param args
  * @example
  * joinStrings('a', 'b', 'c') // 'abc'
  * joinStrings('a', false, 'c') // 'ac'