@isdk/ai-tool 0.5.8 → 0.7.0

package/docs/{classes → api/classes}/AbortError.md

@@ -6,7 +6,7 @@
 
 # Class: AbortError
 
-Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:142
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@isdk+common-error@0.2.0/node\_modules/@isdk/common-error/dist/index.d.ts:153
 
 BaseError class that extends the Error class.
 
@@ -47,7 +47,7 @@ fromJSON - Creates a new BaseError instance from a JSON representation.
 
 > **new AbortError**(`what`?, `name`?): [`AbortError`](AbortError.md)
 
-Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:144
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@isdk+common-error@0.2.0/node\_modules/@isdk/common-error/dist/index.d.ts:155
 
 #### Parameters
 
@@ -73,7 +73,7 @@ Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/com
 
 > **caller**: `string`
 
-Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:63
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@isdk+common-error@0.2.0/node\_modules/@isdk/common-error/dist/index.d.ts:63
 
 The name of the function that threw the error.
 
@@ -87,7 +87,7 @@ The name of the function that threw the error.
 
 > `optional` **cause**: `unknown`
 
-Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26
 
 #### Inherited from
 
@@ -99,7 +99,7 @@ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/li
 
 > **code**: `ErrorCodeType`
 
-Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:64
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@isdk+common-error@0.2.0/node\_modules/@isdk/common-error/dist/index.d.ts:64
 
 the error code
 
@@ -113,7 +113,7 @@ the error code
 
 > `optional` **data**: `any`
 
-Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:65
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@isdk+common-error@0.2.0/node\_modules/@isdk/common-error/dist/index.d.ts:65
 
 Additional data associated with the error.
 
@@ -127,7 +127,7 @@ Additional data associated with the error.
 
 > **message**: `string`
 
-Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1077
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1077
 
 #### Inherited from
 
@@ -139,7 +139,7 @@ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/li
 
 > **name**: `string`
 
-Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1076
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1076
 
 #### Inherited from
 
@@ -151,7 +151,7 @@ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/li
 
 > `optional` **stack**: `string`
 
-Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1078
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1078
 
 #### Inherited from
 
@@ -163,7 +163,7 @@ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/li
 
 > `static` **code**: [`ErrorCode`](../enumerations/ErrorCode.md)
 
-Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:143
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@isdk+common-error@0.2.0/node\_modules/@isdk/common-error/dist/index.d.ts:154
 
 The error code associated with the error.
 
@@ -173,43 +173,21 @@ The error code associated with the error.
 
 ***
 
-### prepareStackTrace()?
-
-> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any`
-
-Defined in: node\_modules/.pnpm/@types+node@22.10.5/node\_modules/@types/node/globals.d.ts:143
-
-Optional override for formatting stack traces
-
-#### Parameters
-
-##### err
-
-`Error`
-
-##### stackTraces
+### stackTraceLimit
 
-`CallSite`[]
+> `static` **stackTraceLimit**: `number`
 
-#### Returns
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@types+node@24.3.0/node\_modules/@types/node/globals.d.ts:162
 
-`any`
+The `Error.stackTraceLimit` property specifies the number of stack frames
+collected by a stack trace (whether generated by `new Error().stack` or
+`Error.captureStackTrace(obj)`).
 
-#### See
+The default value is `10` but may be set to any valid JavaScript number. Changes
+will affect any stack trace captured _after_ the value has been changed.
 
-https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-
-#### Inherited from
-
-[`CommonError`](CommonError.md).[`prepareStackTrace`](CommonError.md#preparestacktrace)
-
-***
-
-### stackTraceLimit
-
-> `static` **stackTraceLimit**: `number`
-
-Defined in: node\_modules/.pnpm/@types+node@22.10.5/node\_modules/@types/node/globals.d.ts:145
+If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
 
 #### Inherited from
 
@@ -221,9 +199,7 @@ Defined in: node\_modules/.pnpm/@types+node@22.10.5/node\_modules/@types/node/gl
 
 > **fromJSON**(`json`): [`BaseError`](BaseError.md)
 
-Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:93
-
-Creates a new BaseError instance from a JSON representation.
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@isdk+common-error@0.2.0/node\_modules/@isdk/common-error/dist/index.d.ts:104
 
 #### Parameters
 
@@ -231,14 +207,10 @@ Creates a new BaseError instance from a JSON representation.
 
 `any`
 
-A JSON representation of the error.
-
 #### Returns
 
 [`BaseError`](BaseError.md)
 
-A new BaseError instance.
-
 #### Inherited from
 
 [`CommonError`](CommonError.md).[`fromJSON`](CommonError.md#fromjson)
@@ -249,7 +221,7 @@ A new BaseError instance.
 
 > **toJSON**(): `any`
 
-Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:86
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@isdk+common-error@0.2.0/node\_modules/@isdk/common-error/dist/index.d.ts:86
 
 Returns a JSON representation of the error.
 
@@ -269,9 +241,51 @@ A JSON representation of the error.
 
 > `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
 
-Defined in: node\_modules/.pnpm/@types+node@22.10.5/node\_modules/@types/node/globals.d.ts:136
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@types+node@24.3.0/node\_modules/@types/node/globals.d.ts:146
 
-Create .stack property on a target object
+Creates a `.stack` property on `targetObject`, which when accessed returns
+a string representing the location in the code at which
+`Error.captureStackTrace()` was called.
+
+```js
+const myObject = {};
+Error.captureStackTrace(myObject);
+myObject.stack;  // Similar to `new Error().stack`
+```
+
+The first line of the trace will be prefixed with
+`${myObject.name}: ${myObject.message}`.
+
+The optional `constructorOpt` argument accepts a function. If given, all frames
+above `constructorOpt`, including `constructorOpt`, will be omitted from the
+generated stack trace.
+
+The `constructorOpt` argument is useful for hiding implementation
+details of error generation from the user. For instance:
+
+```js
+function a() {
+  b();
+}
+
+function b() {
+  c();
+}
+
+function c() {
+  // Create an error without stack trace to avoid calculating the stack trace twice.
+  const { stackTraceLimit } = Error;
+  Error.stackTraceLimit = 0;
+  const error = new Error();
+  Error.stackTraceLimit = stackTraceLimit;
+
+  // Capture the stack trace above function b
+  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
+  throw error;
+}
+
+a();
+```
 
 #### Parameters
 
@@ -297,7 +311,7 @@ Create .stack property on a target object
 
 > `static` **create**(`__namedParameters`): [`CommonError`](CommonError.md)
 
-Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:96
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@isdk+common-error@0.2.0/node\_modules/@isdk/common-error/dist/index.d.ts:107
 
 #### Parameters
 
@@ -333,7 +347,7 @@ Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/com
 
 > `static` **createErrorClass**(`aType`, `aErrorCode`?, `ParentErrorClass`?): *typeof* [`BaseError`](BaseError.md)
 
-Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:66
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@isdk+common-error@0.2.0/node\_modules/@isdk/common-error/dist/index.d.ts:66
 
 Create an Error Class
 
@@ -364,3 +378,74 @@ the new Error Class
 #### Inherited from
 
 [`CommonError`](CommonError.md).[`createErrorClass`](CommonError.md#createerrorclass)
+
+***
+
+### fromJSON()
+
+> `static` **fromJSON**(`json`): [`BaseError`](BaseError.md)
+
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@isdk+common-error@0.2.0/node\_modules/@isdk/common-error/dist/index.d.ts:103
+
+Creates a new error instance from a JSON representation.
+This method is useful for deserializing an error that was serialized with `toJSON`.
+
+#### Parameters
+
+##### json
+
+`any`
+
+A JSON object representing the error.
+
+#### Returns
+
+[`BaseError`](BaseError.md)
+
+A new instance of the error class (or a subclass).
+
+#### Example
+
+```ts
+const originalError = new NotFoundError('thing');
+const json = originalError.toJSON();
+
+// Deserialize
+const newError = NotFoundError.fromJSON(json);
+console.log(newError instanceof NotFoundError); // true
+console.log(newError.message); // 'Could not find thing.'
+```
+
+#### Inherited from
+
+[`CommonError`](CommonError.md).[`fromJSON`](CommonError.md#fromjson-2)
+
+***
+
+### prepareStackTrace()
+
+> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`
+
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@types+node@24.3.0/node\_modules/@types/node/globals.d.ts:150
+
+#### Parameters
+
+##### err
+
+`Error`
+
+##### stackTraces
+
+`CallSite`[]
+
+#### Returns
+
+`any`
+
+#### See
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+#### Inherited from
+
+[`CommonError`](CommonError.md).[`prepareStackTrace`](CommonError.md#preparestacktrace)