@isdk/ai-tool 0.2.0 → 0.2.1

package/docs/classes/BaseError.md

@@ -1,10 +1,14 @@
-[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / BaseError
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / BaseError
 
 # Class: BaseError
 
 BaseError class that extends the Error class.
 
-**`Example`**
+## Example
 
 ```ts
 // Create a custom error
@@ -19,69 +23,48 @@ class CustomError extends BaseError {
 throw new CustomError('This is a custom error');
 ```
 
-**`Description`**
+## Description
 
 This class is used to create custom errors that extend the built-in Error class. It provides a way to define custom error codes and additional data associated with the error.
 
-**`Method`**
+## Method
 
 toJSON - Returns a JSON representation of the error.
 
-**`Method`**
+## Method
 
 fromJSON - Creates a new BaseError instance from a JSON representation.
 
-## Hierarchy
+## Extends
 
 - `AbstractError`
 
-  ↳ **`BaseError`**
-
-  ↳↳ [`CommonError`](CommonError.md)
-
-  ↳↳ [`ReadableStreamError`](ReadableStreamError.md)
+## Extended by
 
-## Table of contents
+- [`CommonError`](CommonError.md)
+- [`ReadableStreamError`](ReadableStreamError.md)
 
-### Constructors
-
-- [constructor](BaseError.md#constructor)
+## Constructors
 
-### Properties
+### new BaseError()
 
-- [caller](BaseError.md#caller)
-- [cause](BaseError.md#cause)
-- [code](BaseError.md#code)
-- [data](BaseError.md#data)
-- [message](BaseError.md#message)
-- [name](BaseError.md#name)
-- [stack](BaseError.md#stack)
-- [code](BaseError.md#code-1)
-- [prepareStackTrace](BaseError.md#preparestacktrace)
-- [stackTraceLimit](BaseError.md#stacktracelimit)
+> **new BaseError**(`message`, `code`?, `name`?): [`BaseError`](BaseError.md)
 
-### Methods
+Constructs a new BaseError instance.
 
-- [fromJSON](BaseError.md#fromjson)
-- [toJSON](BaseError.md#tojson)
-- [captureStackTrace](BaseError.md#capturestacktrace)
-- [createErrorClass](BaseError.md#createerrorclass)
+#### Parameters
 
-## Constructors
+• **message**: `string`
 
-### constructor
+The error message.
 
-• **new BaseError**(`message`, `code?`, `name?`): [`BaseError`](BaseError.md)
+• **code?**: `ErrorCodeType`
 
-Constructs a new BaseError instance.
+The error code.
 
-#### Parameters
+• **name?**: `string` \| `object`
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `message` | `string` | The error message. |
-| `code?` | `ErrorCodeType` | The error code. |
-| `name?` | `string` \| `object` | The error name or additional properties. |
+The error name or additional properties.
 
 #### Returns
 
@@ -89,180 +72,177 @@ Constructs a new BaseError instance.
 
 #### Overrides
 
-AbstractError.constructor
+`AbstractError.constructor`
 
 #### Defined in
 
-node_modules/.pnpm/@isdk+common-error@0.1.1/node_modules/@isdk/common-error/dist/index.d.ts:74
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:74
 
 ## Properties
 
 ### caller
 
-• **caller**: `string`
+> **caller**: `string`
 
 The name of the function that threw the error.
 
 #### Defined in
 
-node_modules/.pnpm/@isdk+common-error@0.1.1/node_modules/@isdk/common-error/dist/index.d.ts:63
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:63
 
-___
+***
 
-### cause
+### cause?
 
-• `Optional` **cause**: `unknown`
+> `optional` **cause**: `unknown`
 
 #### Inherited from
 
-AbstractError.cause
+`AbstractError.cause`
 
 #### Defined in
 
-node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2022.error.d.ts:24
+node\_modules/.pnpm/typescript@5.6.2/node\_modules/typescript/lib/lib.es2022.error.d.ts:24
 
-___
+***
 
 ### code
 
-• **code**: `ErrorCodeType`
+> **code**: `ErrorCodeType`
+
+the error code
 
 #### Overrides
 
-AbstractError.code
+`AbstractError.code`
 
 #### Defined in
 
-node_modules/.pnpm/@isdk+common-error@0.1.1/node_modules/@isdk/common-error/dist/index.d.ts:64
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:64
 
-___
+***
 
-### data
+### data?
 
-• `Optional` **data**: `any`
+> `optional` **data**: `any`
 
 Additional data associated with the error.
 
 #### Defined in
 
-node_modules/.pnpm/@isdk+common-error@0.1.1/node_modules/@isdk/common-error/dist/index.d.ts:65
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:65
 
-___
+***
 
 ### message
 
-• **message**: `string`
+> **message**: `string`
 
 #### Inherited from
 
-AbstractError.message
+`AbstractError.message`
 
 #### Defined in
 
-node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:1077
+node\_modules/.pnpm/typescript@5.6.2/node\_modules/typescript/lib/lib.es5.d.ts:1077
 
-___
+***
 
 ### name
 
-• **name**: `string`
+> **name**: `string`
 
 #### Inherited from
 
-AbstractError.name
+`AbstractError.name`
 
 #### Defined in
 
-node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:1076
+node\_modules/.pnpm/typescript@5.6.2/node\_modules/typescript/lib/lib.es5.d.ts:1076
 
-___
+***
 
-### stack
+### stack?
 
-• `Optional` **stack**: `string`
+> `optional` **stack**: `string`
 
 #### Inherited from
 
-AbstractError.stack
+`AbstractError.stack`
 
 #### Defined in
 
-node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:1078
+node\_modules/.pnpm/typescript@5.6.2/node\_modules/typescript/lib/lib.es5.d.ts:1078
 
-___
+***
 
 ### code
 
-▪ `Static` **code**: `ErrorCodeType`
+> `static` **code**: `ErrorCodeType`
 
 The error code associated with the error.
 
 #### Defined in
 
-node_modules/.pnpm/@isdk+common-error@0.1.1/node_modules/@isdk/common-error/dist/index.d.ts:62
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:62
 
-___
+***
 
-### prepareStackTrace
+### prepareStackTrace()?
 
-▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
+> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any`
 
 Optional override for formatting stack traces
 
-**`See`**
-
-https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+#### Parameters
 
-#### Type declaration
+• **err**: `Error`
 
-▸ (`err`, `stackTraces`): `any`
+• **stackTraces**: `CallSite`[]
 
-##### Parameters
+#### Returns
 
-| Name | Type |
-| :------ | :------ |
-| `err` | `Error` |
-| `stackTraces` | `CallSite`[] |
+`any`
 
-##### Returns
+#### See
 
-`any`
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
 
 #### Inherited from
 
-AbstractError.prepareStackTrace
+`AbstractError.prepareStackTrace`
 
 #### Defined in
 
-node_modules/.pnpm/@types+node@20.14.2/node_modules/@types/node/globals.d.ts:28
+node\_modules/.pnpm/@types+node@22.5.5/node\_modules/@types/node/globals.d.ts:143
 
-___
+***
 
 ### stackTraceLimit
 
-▪ `Static` **stackTraceLimit**: `number`
+> `static` **stackTraceLimit**: `number`
 
 #### Inherited from
 
-AbstractError.stackTraceLimit
+`AbstractError.stackTraceLimit`
 
 #### Defined in
 
-node_modules/.pnpm/@types+node@20.14.2/node_modules/@types/node/globals.d.ts:30
+node\_modules/.pnpm/@types+node@22.5.5/node\_modules/@types/node/globals.d.ts:145
 
 ## Methods
 
-### fromJSON
+### fromJSON()
 
-▸ **fromJSON**(`json`): [`BaseError`](BaseError.md)
+> **fromJSON**(`json`): [`BaseError`](BaseError.md)
 
 Creates a new BaseError instance from a JSON representation.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `json` | `any` | A JSON representation of the error. |
+• **json**: `any`
+
+A JSON representation of the error.
 
 #### Returns
 
@@ -272,13 +252,13 @@ A new BaseError instance.
 
 #### Defined in
 
-node_modules/.pnpm/@isdk+common-error@0.1.1/node_modules/@isdk/common-error/dist/index.d.ts:87
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:87
 
-___
+***
 
-### toJSON
+### toJSON()
 
-▸ **toJSON**(): `any`
+> **toJSON**(): `any`
 
 Returns a JSON representation of the error.
 
@@ -290,22 +270,21 @@ A JSON representation of the error.
 
 #### Defined in
 
-node_modules/.pnpm/@isdk+common-error@0.1.1/node_modules/@isdk/common-error/dist/index.d.ts:80
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:80
 
-___
+***
 
-### captureStackTrace
+### captureStackTrace()
 
-▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
 
 Create .stack property on a target object
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `targetObject` | `object` |
-| `constructorOpt?` | `Function` |
+• **targetObject**: `object`
+
+• **constructorOpt?**: `Function`
 
 #### Returns
 
@@ -313,34 +292,42 @@ Create .stack property on a target object
 
 #### Inherited from
 
-AbstractError.captureStackTrace
+`AbstractError.captureStackTrace`
 
 #### Defined in
 
-node_modules/.pnpm/@types+node@20.14.2/node_modules/@types/node/globals.d.ts:21
+node\_modules/.pnpm/@types+node@22.5.5/node\_modules/@types/node/globals.d.ts:136
+
+***
 
-___
+### createErrorClass()
 
-### createErrorClass
+> `static` **createErrorClass**(`aType`, `aErrorCode`?, `ParentErrorClass`?): *typeof* [`BaseError`](BaseError.md)
 
-▸ **createErrorClass**(`aType`, `aErrorCode?`, `ParentErrorClass?`): typeof [`BaseError`](BaseError.md)
+Create an Error Class
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `aType` | `string` |
-| `aErrorCode?` | `string` \| `number` \| typeof `AbstractError` |
-| `ParentErrorClass?` | typeof [`BaseError`](BaseError.md) |
+• **aType**: `string`
+
+the error type(class) name
+
+• **aErrorCode?**: `string` \| `number` \| *typeof* `AbstractError`
+
+• **ParentErrorClass?**: *typeof* [`BaseError`](BaseError.md)
+
+the parent error class. defaults to AbstractError
 
 #### Returns
 
-typeof [`BaseError`](BaseError.md)
+*typeof* [`BaseError`](BaseError.md)
+
+the new Error Class
 
 #### Overrides
 
-AbstractError.createErrorClass
+`AbstractError.createErrorClass`
 
 #### Defined in
 
-node_modules/.pnpm/@isdk+common-error@0.1.1/node_modules/@isdk/common-error/dist/index.d.ts:66
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:66