@ls-stack/utils 3.39.0 → 3.41.0

package/docs/retryOnError/README.md

@@ -1,168 +0,0 @@
-[**@ls-stack/utils**](../README.md)
-
-***
-
-[@ls-stack/utils](../modules.md) / retryOnError
-
-# retryOnError
-
-## Modules
-
-- [\<internal\>](-internal-.md)
-
-## Functions
-
-### retryOnError()
-
-```ts
-function retryOnError<T>(
-   fn, 
-   maxRetries, 
-   options, 
-   retry, 
-originalMaxRetries): Promise<T>;
-```
-
-Defined in: [packages/utils/src/retryOnError.ts:46](https://github.com/lucasols/utils/blob/main/packages/utils/src/retryOnError.ts#L46)
-
-Retries a function on error with configurable retry logic.
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Parameters
-
-##### fn
-
-(`ctx`) => `Promise`\<`T`\>
-
-Function to retry that receives context with retry count
-
-##### maxRetries
-
-`number`
-
-Maximum number of retries
-
-##### options
-
-[`RetryOptions`](-internal-.md#retryoptions) = `{}`
-
-Configuration options
-
-##### retry
-
-`number` = `0`
-
-internal use only
-
-##### originalMaxRetries
-
-`number` = `maxRetries`
-
-internal use only
-
-#### Returns
-
-`Promise`\<`T`\>
-
-Promise resolving to the function result or rejecting with the final error
-
-#### Example
-
-```ts
-await retryOnError(
-  async (ctx) => {
-    console.log(`Attempt ${ctx.retry + 1}`);
-    return await fetchData();
-  },
-  3,
-  { delayBetweenRetriesMs: 1000 }
-);
-```
-
-***
-
-### retryResultOnError()
-
-```ts
-function retryResultOnError<T, E>(
-   fn, 
-   maxRetries, 
-   options, 
-   __retry, 
-__originalMaxRetries): Promise<Result<T, E>>;
-```
-
-Defined in: [packages/utils/src/retryOnError.ts:132](https://github.com/lucasols/utils/blob/main/packages/utils/src/retryOnError.ts#L132)
-
-Retries a result function on error with configurable retry logic.
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-##### E
-
-`E` *extends* `ResultValidErrors`
-
-#### Parameters
-
-##### fn
-
-(`ctx`) => `Promise`\<`Result`\<`T`, `E`\>\>
-
-Function to retry that receives context with retry count
-
-##### maxRetries
-
-`number`
-
-Maximum number of retries
-
-##### options
-
-Configuration options
-
-###### debugId?
-
-`string`
-
-###### delayBetweenRetriesMs?
-
-`number` \| (`retry`) => `number`
-
-###### disableRetries?
-
-`boolean`
-
-###### onRetry?
-
-(`error`, `lastAttempt`) => `void`
-
-###### retryCondition?
-
-(`error`, `lastAttempt`) => `boolean`
-
-##### \_\_retry
-
-`number` = `0`
-
-internal use only
-
-##### \_\_originalMaxRetries
-
-`number` = `maxRetries`
-
-internal use only
-
-#### Returns
-
-`Promise`\<`Result`\<`T`, `E`\>\>
-
-Promise resolving to the function result or rejecting with the final error

package/docs/runShellCmd/-internal-.md

@@ -1,111 +0,0 @@
-[**@ls-stack/utils**](../README.md)
-
-***
-
-[@ls-stack/utils](../modules.md) / [runShellCmd](README.md) / \<internal\>
-
-# \<internal\>
-
-## Type Aliases
-
-### CmdResult
-
-```ts
-type CmdResult = object;
-```
-
-Defined in: [packages/utils/src/runShellCmd.ts:3](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L3)
-
-#### Properties
-
-##### error
-
-```ts
-error: boolean;
-```
-
-Defined in: [packages/utils/src/runShellCmd.ts:6](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L6)
-
-##### label
-
-```ts
-label: string | null;
-```
-
-Defined in: [packages/utils/src/runShellCmd.ts:4](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L4)
-
-##### out
-
-```ts
-out: string;
-```
-
-Defined in: [packages/utils/src/runShellCmd.ts:5](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L5)
-
-##### stderr
-
-```ts
-stderr: string;
-```
-
-Defined in: [packages/utils/src/runShellCmd.ts:8](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L8)
-
-##### stdout
-
-```ts
-stdout: string;
-```
-
-Defined in: [packages/utils/src/runShellCmd.ts:7](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L7)
-
-***
-
-### RunCmdOptions
-
-```ts
-type RunCmdOptions = object;
-```
-
-Defined in: [packages/utils/src/runShellCmd.ts:13](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L13)
-
-#### Properties
-
-##### cwd?
-
-```ts
-optional cwd: string;
-```
-
-Defined in: [packages/utils/src/runShellCmd.ts:16](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L16)
-
-##### mock?
-
-```ts
-optional mock: CmdResult;
-```
-
-Defined in: [packages/utils/src/runShellCmd.ts:14](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L14)
-
-##### noCiColorForce?
-
-```ts
-optional noCiColorForce: boolean;
-```
-
-Defined in: [packages/utils/src/runShellCmd.ts:18](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L18)
-
-##### silent?
-
-```ts
-optional silent: boolean | "timeOnly";
-```
-
-Defined in: [packages/utils/src/runShellCmd.ts:15](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L15)
-
-##### throwOnError?
-
-```ts
-optional throwOnError: boolean;
-```
-
-Defined in: [packages/utils/src/runShellCmd.ts:17](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L17)

package/docs/runShellCmd/README.md

@@ -1,201 +0,0 @@
-[**@ls-stack/utils**](../README.md)
-
-***
-
-[@ls-stack/utils](../modules.md) / runShellCmd
-
-# runShellCmd
-
-## Modules
-
-- [\<internal\>](-internal-.md)
-
-## Functions
-
-### ~~concurrentCmd()~~
-
-```ts
-function concurrentCmd(
-   label, 
-   cmd, 
-onResult): Promise<() => void>;
-```
-
-Defined in: [packages/utils/src/runShellCmd.ts:133](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L133)
-
-#### Parameters
-
-##### label
-
-`string`
-
-##### cmd
-
-`string` | `string`[]
-
-##### onResult
-
-(`result`) => `void`
-
-#### Returns
-
-`Promise`\<() => `void`\>
-
-#### Deprecated
-
-This utility has been moved to @ls-stack/node-utils. Please update your imports:
-```
-// Old (deprecated)
-import { concurrentCmd } from '@ls-stack/utils/runShellCmd';
-
-// New (preferred)
-import { concurrentCmd } from '@ls-stack/node-utils/runShellCmd';
-```
-
-***
-
-### ~~runCmd()~~
-
-```ts
-function runCmd(
-   label, 
-   command, 
-root0): Promise<CmdResult>;
-```
-
-Defined in: [packages/utils/src/runShellCmd.ts:39](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L39)
-
-#### Parameters
-
-##### label
-
-`null` | `string`
-
-##### command
-
-`string` | `string`[]
-
-##### root0
-
-[`RunCmdOptions`](-internal-.md#runcmdoptions) = `{}`
-
-#### Returns
-
-`Promise`\<[`CmdResult`](-internal-.md#cmdresult)\>
-
-#### Deprecated
-
-This utility has been moved to @ls-stack/node-utils. Please update your imports:
-```
-// Old (deprecated)
-import { runCmd } from '@ls-stack/utils/runShellCmd';
-
-// New (preferred)
-import { runCmd } from '@ls-stack/node-utils/runShellCmd';
-```
-
-***
-
-### ~~runCmdSilent()~~
-
-```ts
-function runCmdSilent(command): Promise<CmdResult>;
-```
-
-Defined in: [packages/utils/src/runShellCmd.ts:198](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L198)
-
-#### Parameters
-
-##### command
-
-`string` | `string`[]
-
-#### Returns
-
-`Promise`\<[`CmdResult`](-internal-.md#cmdresult)\>
-
-#### Deprecated
-
-This utility has been moved to @ls-stack/node-utils. Please update your imports:
-```
-// Old (deprecated)
-import { runCmdSilent } from '@ls-stack/utils/runShellCmd';
-
-// New (preferred)
-import { runCmdSilent } from '@ls-stack/node-utils/runShellCmd';
-```
-
-***
-
-### ~~runCmdSilentUnwrap()~~
-
-```ts
-function runCmdSilentUnwrap(command): Promise<string>;
-```
-
-Defined in: [packages/utils/src/runShellCmd.ts:213](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L213)
-
-#### Parameters
-
-##### command
-
-`string` | `string`[]
-
-#### Returns
-
-`Promise`\<`string`\>
-
-#### Deprecated
-
-This utility has been moved to @ls-stack/node-utils. Please update your imports:
-```
-// Old (deprecated)
-import { runCmdSilentUnwrap } from '@ls-stack/utils/runShellCmd';
-
-// New (preferred)
-import { runCmdSilentUnwrap } from '@ls-stack/node-utils/runShellCmd';
-```
-
-***
-
-### ~~runCmdUnwrap()~~
-
-```ts
-function runCmdUnwrap(
-   label, 
-   command, 
-root0): Promise<string>;
-```
-
-Defined in: [packages/utils/src/runShellCmd.ts:175](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L175)
-
-#### Parameters
-
-##### label
-
-`null` | `string`
-
-##### command
-
-`string` | `string`[]
-
-##### root0
-
-###### silent?
-
-`boolean` \| `"timeOnly"`
-
-#### Returns
-
-`Promise`\<`string`\>
-
-#### Deprecated
-
-This utility has been moved to @ls-stack/node-utils. Please update your imports:
-```
-// Old (deprecated)
-import { runCmdUnwrap } from '@ls-stack/utils/runShellCmd';
-
-// New (preferred)
-import { runCmdUnwrap } from '@ls-stack/node-utils/runShellCmd';
-```

package/docs/safeJson.md

@@ -1,51 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / safeJson
-
-# safeJson
-
-## Functions
-
-### safeJsonParse()
-
-```ts
-function safeJsonParse(value): unknown;
-```
-
-Defined in: [packages/utils/src/safeJson.ts:17](https://github.com/lucasols/utils/blob/main/packages/utils/src/safeJson.ts#L17)
-
-JSON.parse can throw if the value is not valid JSON, this function catches those errors and returns undefined
-
-#### Parameters
-
-##### value
-
-`string`
-
-#### Returns
-
-`unknown`
-
-***
-
-### safeJsonStringify()
-
-```ts
-function safeJsonStringify(value): undefined | string;
-```
-
-Defined in: [packages/utils/src/safeJson.ts:5](https://github.com/lucasols/utils/blob/main/packages/utils/src/safeJson.ts#L5)
-
-JSON.stringify can throw if the value is circular or contains functions, this function catches those errors and returns undefined
-
-#### Parameters
-
-##### value
-
-`unknown`
-
-#### Returns
-
-`undefined` \| `string`