@isdk/ai-tool 0.4.0 → 0.5.1

package/docs/classes/BaseError.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -6,6 +6,8 @@
 
 # Class: BaseError
 
+Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:58
+
 BaseError class that extends the Error class.
 
 ## Example
@@ -50,22 +52,30 @@ fromJSON - Creates a new BaseError instance from a JSON representation.
 
 > **new BaseError**(`message`, `code`?, `name`?): [`BaseError`](BaseError.md)
 
+Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:80
+
 Constructs a new BaseError instance.
 
 #### Parameters
 
-• **message**: `string`
+##### message
+
+`string`
 
 The error message.
 
-• **code?**: `ErrorCodeType`
+##### code?
+
+`ErrorCodeType`
 
 The error code.
 
-• **name?**: `string` \| `Record`\<`string`, `any`\>
+##### name?
 
 The error name or additional properties.
 
+`string` | `Record`\<`string`, `any`\>
+
 #### Returns
 
 [`BaseError`](BaseError.md)
@@ -74,21 +84,15 @@ The error name or additional properties.
 
 `AbstractError.constructor`
 
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:80
-
 ## Properties
 
 ### caller
 
 > **caller**: `string`
 
-The name of the function that threw the error.
-
-#### Defined in
+Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:63
 
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:63
+The name of the function that threw the error.
 
 ***
 
@@ -96,41 +100,35 @@ node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/di
 
 > `optional` **cause**: `unknown`
 
+Defined in: node\_modules/.pnpm/typescript@5.7.2/node\_modules/typescript/lib/lib.es2022.error.d.ts:26
+
 #### Inherited from
 
 `AbstractError.cause`
 
-#### Defined in
-
-node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:24
-
 ***
 
 ### code
 
 > **code**: `ErrorCodeType`
 
+Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:64
+
 the error code
 
 #### Overrides
 
 `AbstractError.code`
 
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:64
-
 ***
 
 ### data?
 
 > `optional` **data**: `any`
 
-Additional data associated with the error.
-
-#### Defined in
+Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:65
 
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:65
+Additional data associated with the error.
 
 ***
 
@@ -138,53 +136,45 @@ node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/di
 
 > **message**: `string`
 
+Defined in: node\_modules/.pnpm/typescript@5.7.2/node\_modules/typescript/lib/lib.es5.d.ts:1077
+
 #### Inherited from
 
 `AbstractError.message`
 
-#### Defined in
-
-node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1077
-
 ***
 
 ### name
 
 > **name**: `string`
 
+Defined in: node\_modules/.pnpm/typescript@5.7.2/node\_modules/typescript/lib/lib.es5.d.ts:1076
+
 #### Inherited from
 
 `AbstractError.name`
 
-#### Defined in
-
-node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1076
-
 ***
 
 ### stack?
 
 > `optional` **stack**: `string`
 
+Defined in: node\_modules/.pnpm/typescript@5.7.2/node\_modules/typescript/lib/lib.es5.d.ts:1078
+
 #### Inherited from
 
 `AbstractError.stack`
 
-#### Defined in
-
-node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1078
-
 ***
 
 ### code
 
 > `static` **code**: `ErrorCodeType`
 
-The error code associated with the error.
-
-#### Defined in
+Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:62
 
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:62
+The error code associated with the error.
 
 ***
 
@@ -192,13 +182,19 @@ node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/di
 
 > `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`
+##### err
+
+`Error`
+
+##### stackTraces
 
-• **stackTraces**: `CallSite`[]
+`CallSite`[]
 
 #### Returns
 
@@ -212,35 +208,33 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
 
 `AbstractError.prepareStackTrace`
 
-#### Defined in
-
-node\_modules/.pnpm/@types+node@22.7.6/node\_modules/@types/node/globals.d.ts:143
-
 ***
 
 ### stackTraceLimit
 
 > `static` **stackTraceLimit**: `number`
 
+Defined in: node\_modules/.pnpm/@types+node@22.10.5/node\_modules/@types/node/globals.d.ts:145
+
 #### Inherited from
 
 `AbstractError.stackTraceLimit`
 
-#### Defined in
-
-node\_modules/.pnpm/@types+node@22.7.6/node\_modules/@types/node/globals.d.ts:145
-
 ## Methods
 
 ### fromJSON()
 
 > **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.
 
 #### Parameters
 
-• **json**: `any`
+##### json
+
+`any`
 
 A JSON representation of the error.
 
@@ -250,16 +244,14 @@ A JSON representation of the error.
 
 A new BaseError instance.
 
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:93
-
 ***
 
 ### toJSON()
 
 > **toJSON**(): `any`
 
+Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:86
+
 Returns a JSON representation of the error.
 
 #### Returns
@@ -268,23 +260,25 @@ Returns a JSON representation of the error.
 
 A JSON representation of the error.
 
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:86
-
 ***
 
 ### captureStackTrace()
 
 > `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
 
+Defined in: node\_modules/.pnpm/@types+node@22.10.5/node\_modules/@types/node/globals.d.ts:136
+
 Create .stack property on a target object
 
 #### Parameters
 
-• **targetObject**: `object`
+##### targetObject
+
+`object`
 
-• **constructorOpt?**: `Function`
+##### constructorOpt?
+
+`Function`
 
 #### Returns
 
@@ -294,35 +288,37 @@ Create .stack property on a target object
 
 `AbstractError.captureStackTrace`
 
-#### Defined in
-
-node\_modules/.pnpm/@types+node@22.7.6/node\_modules/@types/node/globals.d.ts:136
-
 ***
 
 ### create()
 
 > `static` **create**(`__namedParameters`): [`BaseError`](BaseError.md)
 
+Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:67
+
 #### Parameters
 
-• **\_\_namedParameters**
+##### \_\_namedParameters
 
-• **\_\_namedParameters.code?**: `string` \| `number`
+###### code?
 
-• **\_\_namedParameters.data?**: `any`
+`string` \| `number`
 
-• **\_\_namedParameters.error**: `string`
+###### data?
 
-• **\_\_namedParameters.name?**: `string`
+`any`
 
-#### Returns
+###### error
 
-[`BaseError`](BaseError.md)
+`string`
+
+###### name?
 
-#### Defined in
+`string`
+
+#### Returns
 
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:67
+[`BaseError`](BaseError.md)
 
 ***
 
@@ -330,17 +326,25 @@ node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/di
 
 > `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
+
 Create an Error Class
 
 #### Parameters
 
-• **aType**: `string`
+##### aType
+
+`string`
 
 the error type(class) name
 
-• **aErrorCode?**: `string` \| `number` \| *typeof* `AbstractError`
+##### aErrorCode?
+
+`string` | `number` | *typeof* `AbstractError`
 
-• **ParentErrorClass?**: *typeof* [`BaseError`](BaseError.md)
+##### ParentErrorClass?
+
+*typeof* [`BaseError`](BaseError.md)
 
 the parent error class. defaults to AbstractError
 
@@ -353,7 +357,3 @@ the new Error Class
 #### Overrides
 
 `AbstractError.createErrorClass`
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:66