@isdk/ai-tool 0.2.0 → 0.2.2

package/docs/functions/toDate.md

@@ -0,0 +1,76 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / toDate
+
+# Function: toDate()
+
+> **toDate**\<`DateType`, `ResultDate`\>(`argument`, `context`?): `ResultDate`
+
+## Type Parameters
+
+• **DateType** *extends* `Date` \| `ConstructableDate`
+
+The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+
+• **ResultDate** *extends* `Date` = `DateType`
+
+The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
+
+## Parameters
+
+• **argument**: `DateArg`\<`DateType`\>
+
+The value to convert
+
+• **context?**: `ContextFn`\<`ResultDate`\>
+
+## Returns
+
+`ResultDate`
+
+The parsed date in the local time zone
+
+## Name
+
+toDate
+
+## Summary
+
+Convert the given argument to an instance of Date.
+
+## Description
+
+Convert the given argument to an instance of Date.
+
+If the argument is an instance of Date, the function returns its clone.
+
+If the argument is a number, it is treated as a timestamp.
+
+If the argument is none of the above, the function returns Invalid Date.
+
+Starting from v3.7.0, it clones a date using `[Symbol.for("constructDateFrom")]`
+enabling to transfer extra properties from the reference date to the new date.
+It's useful for extensions like [`TZDate`](https://github.com/date-fns/tz)
+that accept a time zone as a constructor argument.
+
+**Note**: *all* Date arguments passed to any *date-fns* function is processed by `toDate`.
+
+## Examples
+
+```ts
+// Clone the date:
+const result = toDate(new Date(2014, 1, 11, 11, 30, 30))
+//=> Tue Feb 11 2014 11:30:30
+```
+
+```ts
+// Convert the timestamp to date:
+const result = toDate(1392098430000)
+//=> Tue Feb 11 2014 11:30:30
+```
+
+## Defined in
+
+node\_modules/.pnpm/date-fns@4.1.0/node\_modules/date-fns/toDate.d.ts:40

package/docs/functions/toDateTime.md

@@ -0,0 +1,21 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / toDateTime
+
+# Function: toDateTime()
+
+> **toDateTime**(`date`): `undefined` \| `Date`
+
+## Parameters
+
+• **date**: `string` \| `number` \| `Date`
+
+## Returns
+
+`undefined` \| `Date`
+
+## Defined in
+
+[packages/ai-tool/src/utils/to-datetime.ts:9](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/to-datetime.ts#L9)

package/docs/functions/trimStartOfStreamHelper.md

@@ -0,0 +1,41 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / trimStartOfStreamHelper
+
+# Function: trimStartOfStreamHelper()
+
+> **trimStartOfStreamHelper**(): (`text`) => `string`
+
+Returns a stateful function that, when invoked, trims leading whitespace
+from the input text. The trimming only occurs on the first invocation, ensuring that
+subsequent calls do not alter the input text. This is particularly useful in scenarios
+where a text stream is being processed and only the initial whitespace should be removed.
+
+## Returns
+
+`Function`
+
+A function that takes a string as input and returns a string
+with leading whitespace removed if it is the first invocation; otherwise, it returns the input unchanged.
+
+### Parameters
+
+• **text**: `string`
+
+### Returns
+
+`string`
+
+## Example
+
+```ts
+const trimStart = trimStartOfStreamHelper();
+const output1 = trimStart("   text"); // "text"
+const output2 = trimStart("   text"); // "   text"
+```
+
+## Defined in
+
+[packages/ai-tool/src/utils/stream/ai-stream.ts:92](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/stream/ai-stream.ts#L92)

package/docs/functions/truncTo.md

@@ -0,0 +1,47 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / truncTo
+
+# Function: truncTo()
+
+> **truncTo**(`n`, `dec`, `up`): `number`
+
+Truncates(Round) a number to a specified number of decimal places.
+
+## Parameters
+
+• **n**: `number`
+
+The number to truncate.
+
+• **dec**: `number` = `2`
+
+The number of decimal places to truncate to (default is 2).
+
+• **up**: `number` = `0.5`
+
+The amount to round up by before truncating (default is 0.5).
+
+## Returns
+
+`number`
+
+The truncated number.
+
+## Examples
+
+```ts
+// returns 1.235
+truncTo(1.2345, 3)
+```
+
+```ts
+// returns 1.24
+truncTo(1.2345, 2, 0.6)
+```
+
+## Defined in
+
+[packages/ai-tool/src/utils/trunc-to.ts:19](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/trunc-to.ts#L19)

package/docs/functions/uuid.md

@@ -0,0 +1,23 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / uuid
+
+# Function: uuid()
+
+> **uuid**(`ver`, `encode`?): `string`
+
+## Parameters
+
+• **ver**: `1` \| `4` \| `5` = `1`
+
+• **encode?**: `boolean`
+
+## Returns
+
+`string`
+
+## Defined in
+
+[packages/ai-tool/src/utils/hash/uuid.ts:8](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/hash/uuid.ts#L8)

package/docs/functions/uuidParse.md

@@ -0,0 +1,21 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / uuidParse
+
+# Function: uuidParse()
+
+> **uuidParse**(`uuid`): `Uint8Array`
+
+## Parameters
+
+• **uuid**: `string`
+
+## Returns
+
+`Uint8Array`
+
+## Defined in
+
+node\_modules/.pnpm/@types+uuid@10.0.0/node\_modules/@types/uuid/index.d.ts:102

package/docs/functions/uuidStringify.md

@@ -0,0 +1,23 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / uuidStringify
+
+# Function: uuidStringify()
+
+> **uuidStringify**(`buffer`, `offset`?): `string`
+
+## Parameters
+
+• **buffer**: `InputBuffer`
+
+• **offset?**: `number`
+
+## Returns
+
+`string`
+
+## Defined in
+
+node\_modules/.pnpm/@types+uuid@10.0.0/node\_modules/@types/uuid/index.d.ts:103

package/docs/functions/uuidValidate.md

@@ -0,0 +1,21 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / uuidValidate
+
+# Function: uuidValidate()
+
+> **uuidValidate**(`uuid`): `boolean`
+
+## Parameters
+
+• **uuid**: `string`
+
+## Returns
+
+`boolean`
+
+## Defined in
+
+node\_modules/.pnpm/@types+uuid@10.0.0/node\_modules/@types/uuid/index.d.ts:112

package/docs/functions/uuidVersion.md

@@ -0,0 +1,21 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / uuidVersion
+
+# Function: uuidVersion()
+
+> **uuidVersion**(`uuid`): `number`
+
+## Parameters
+
+• **uuid**: `string`
+
+## Returns
+
+`number`
+
+## Defined in
+
+node\_modules/.pnpm/@types+uuid@10.0.0/node\_modules/@types/uuid/index.d.ts:113

package/docs/functions/uuidv1.md

@@ -0,0 +1,47 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / uuidv1
+
+# Function: uuidv1()
+
+## uuidv1(options, buffer, offset)
+
+> **uuidv1**\<`T`\>(`options`, `buffer`, `offset`?): `T`
+
+### Type Parameters
+
+• **T** *extends* `OutputBuffer`
+
+### Parameters
+
+• **options**: `undefined` \| `null` \| `V1Options`
+
+• **buffer**: `T`
+
+• **offset?**: `number`
+
+### Returns
+
+`T`
+
+### Defined in
+
+node\_modules/.pnpm/@types+uuid@10.0.0/node\_modules/@types/uuid/index.d.ts:104
+
+## uuidv1(options)
+
+> **uuidv1**(`options`?): `string`
+
+### Parameters
+
+• **options?**: `V1Options`
+
+### Returns
+
+`string`
+
+### Defined in
+
+node\_modules/.pnpm/@types+uuid@10.0.0/node\_modules/@types/uuid/index.d.ts:104

package/docs/functions/uuidv4.md

@@ -0,0 +1,47 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / uuidv4
+
+# Function: uuidv4()
+
+## uuidv4(options, buffer, offset)
+
+> **uuidv4**\<`T`\>(`options`, `buffer`, `offset`?): `T`
+
+### Type Parameters
+
+• **T** *extends* `OutputBuffer`
+
+### Parameters
+
+• **options**: `undefined` \| `null` \| `V4Options`
+
+• **buffer**: `T`
+
+• **offset?**: `number`
+
+### Returns
+
+`T`
+
+### Defined in
+
+node\_modules/.pnpm/@types+uuid@10.0.0/node\_modules/@types/uuid/index.d.ts:107
+
+## uuidv4(options)
+
+> **uuidv4**(`options`?): `string`
+
+### Parameters
+
+• **options?**: `V4Options`
+
+### Returns
+
+`string`
+
+### Defined in
+
+node\_modules/.pnpm/@types+uuid@10.0.0/node\_modules/@types/uuid/index.d.ts:107

package/docs/functions/uuidv5.md

@@ -0,0 +1,51 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / uuidv5
+
+# Function: uuidv5()
+
+## uuidv5(name, namespace, buffer, offset)
+
+> **uuidv5**\<`T`\>(`name`, `namespace`, `buffer`, `offset`?): `T`
+
+### Type Parameters
+
+• **T** *extends* `OutputBuffer`
+
+### Parameters
+
+• **name**: `string` \| `InputBuffer`
+
+• **namespace**: `string` \| `InputBuffer`
+
+• **buffer**: `T`
+
+• **offset?**: `number`
+
+### Returns
+
+`T`
+
+### Defined in
+
+node\_modules/.pnpm/@types+uuid@10.0.0/node\_modules/@types/uuid/index.d.ts:108
+
+## uuidv5(name, namespace)
+
+> **uuidv5**(`name`, `namespace`): `string`
+
+### Parameters
+
+• **name**: `string` \| `InputBuffer`
+
+• **namespace**: `string` \| `InputBuffer`
+
+### Returns
+
+`string`
+
+### Defined in
+
+node\_modules/.pnpm/@types+uuid@10.0.0/node\_modules/@types/uuid/index.d.ts:108

package/docs/functions/wait.md

@@ -0,0 +1,21 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / wait
+
+# Function: wait()
+
+> **wait**(`ms`): `Promise`\<`void`\>
+
+## Parameters
+
+• **ms**: `number`
+
+## Returns
+
+`Promise`\<`void`\>
+
+## Defined in
+
+[packages/ai-tool/src/utils/wait.ts:1](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/wait.ts#L1)

package/docs/functions/xxhash.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / xxhash
+
+# Function: xxhash()
+
+> **xxhash**(`value`, `hashAlgo`, `seed`): `Uint8Array`
+
+## Parameters
+
+• **value**: `HashValue`
+
+• **hashAlgo**: [`XXHashAlgorithm`](../enumerations/XXHashAlgorithm.md) = `XXHashAlgorithm.xxhash64`
+
+• **seed**: `number` = `SEED`
+
+## Returns
+
+`Uint8Array`
+
+## Defined in
+
+[packages/ai-tool/src/utils/hash/xxhash.ts:32](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/hash/xxhash.ts#L32)

package/docs/functions/xxhash32.md

@@ -0,0 +1,23 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / xxhash32
+
+# Function: xxhash32()
+
+> **xxhash32**(`value`, `radix`): `string`
+
+## Parameters
+
+• **value**: `string` \| `object`
+
+• **radix**: `number` = `16`
+
+## Returns
+
+`string`
+
+## Defined in
+
+[packages/ai-tool/src/utils/hash/xxhash.ts:11](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/hash/xxhash.ts#L11)

package/docs/functions/xxhash64.md

@@ -0,0 +1,23 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / xxhash64
+
+# Function: xxhash64()
+
+> **xxhash64**(`value`, `radix`): `string`
+
+## Parameters
+
+• **value**: `string` \| `object`
+
+• **radix**: `number` = `16`
+
+## Returns
+
+`string`
+
+## Defined in
+
+[packages/ai-tool/src/utils/hash/xxhash.ts:18](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/hash/xxhash.ts#L18)

package/docs/functions/xxhashAsStr.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / xxhashAsStr
+
+# Function: xxhashAsStr()
+
+> **xxhashAsStr**(`value`, `hashAlgo`, `seed`): `string`
+
+## Parameters
+
+• **value**: `string` \| `Uint8Array`
+
+• **hashAlgo**: [`XXHashAlgorithm`](../enumerations/XXHashAlgorithm.md) = `XXHashAlgorithm.xxhash64`
+
+• **seed**: `number` = `SEED`
+
+## Returns
+
+`string`
+
+## Defined in
+
+[packages/ai-tool/src/utils/hash/xxhash.ts:48](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/hash/xxhash.ts#L48)