@isdk/ai-tool 0.3.0 → 0.5.0

package/docs/classes/CommonError.md

@@ -1,377 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / CommonError
-
-# Class: CommonError
-
-BaseError class that extends the Error class.
-
-## Example
-
-```ts
-// Create a custom error
-class CustomError extends BaseError {
-  static code = 'customError';
-  constructor(message: string) {
-    super(message);
-  }
-}
-
-// Throw the custom error
-throw new CustomError('This is a custom error');
-```
-
-## 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
-
-toJSON - Returns a JSON representation of the error.
-
-## Method
-
-fromJSON - Creates a new BaseError instance from a JSON representation.
-
-## Extends
-
-- [`BaseError`](BaseError.md)
-
-## Extended by
-
-- [`AbortError`](AbortError.md)
-- [`AlreadyExistsError`](AlreadyExistsError.md)
-- [`NotFoundError`](NotFoundError.md)
-- [`NotImplementationError`](NotImplementationError.md)
-
-## Constructors
-
-### new CommonError()
-
-> **new CommonError**(`message`, `name`?, `status`?): [`CommonError`](CommonError.md)
-
-#### Parameters
-
-• **message**: `string`
-
-• **name?**: `string` \| `Record`\<`string`, `any`\>
-
-• **status?**: `ErrorCodeType`
-
-#### Returns
-
-[`CommonError`](CommonError.md)
-
-#### Overrides
-
-[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructors)
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:102
-
-## Properties
-
-### caller
-
-> **caller**: `string`
-
-The name of the function that threw the error.
-
-#### Inherited from
-
-[`BaseError`](BaseError.md).[`caller`](BaseError.md#caller)
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:63
-
-***
-
-### cause?
-
-> `optional` **cause**: `unknown`
-
-#### Inherited from
-
-[`BaseError`](BaseError.md).[`cause`](BaseError.md#cause)
-
-#### Defined in
-
-node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:24
-
-***
-
-### code
-
-> **code**: `ErrorCodeType`
-
-the error code
-
-#### Inherited from
-
-[`BaseError`](BaseError.md).[`code`](BaseError.md#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.
-
-#### Inherited from
-
-[`BaseError`](BaseError.md).[`data`](BaseError.md#data)
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:65
-
-***
-
-### message
-
-> **message**: `string`
-
-#### Inherited from
-
-[`BaseError`](BaseError.md).[`message`](BaseError.md#message)
-
-#### Defined in
-
-node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1077
-
-***
-
-### name
-
-> **name**: `string`
-
-#### Inherited from
-
-[`BaseError`](BaseError.md).[`name`](BaseError.md#name)
-
-#### Defined in
-
-node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1076
-
-***
-
-### stack?
-
-> `optional` **stack**: `string`
-
-#### Inherited from
-
-[`BaseError`](BaseError.md).[`stack`](BaseError.md#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.
-
-#### Inherited from
-
-[`BaseError`](BaseError.md).[`code`](BaseError.md#code-1)
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:62
-
-***
-
-### prepareStackTrace()?
-
-> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any`
-
-Optional override for formatting stack traces
-
-#### Parameters
-
-• **err**: `Error`
-
-• **stackTraces**: `CallSite`[]
-
-#### Returns
-
-`any`
-
-#### See
-
-https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-
-#### Inherited from
-
-[`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace)
-
-#### Defined in
-
-node\_modules/.pnpm/@types+node@22.7.6/node\_modules/@types/node/globals.d.ts:143
-
-***
-
-### stackTraceLimit
-
-> `static` **stackTraceLimit**: `number`
-
-#### Inherited from
-
-[`BaseError`](BaseError.md).[`stackTraceLimit`](BaseError.md#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)
-
-Creates a new BaseError instance from a JSON representation.
-
-#### Parameters
-
-• **json**: `any`
-
-A JSON representation of the error.
-
-#### Returns
-
-[`BaseError`](BaseError.md)
-
-A new BaseError instance.
-
-#### Inherited from
-
-[`BaseError`](BaseError.md).[`fromJSON`](BaseError.md#fromjson)
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:93
-
-***
-
-### toJSON()
-
-> **toJSON**(): `any`
-
-Returns a JSON representation of the error.
-
-#### Returns
-
-`any`
-
-A JSON representation of the error.
-
-#### Inherited from
-
-[`BaseError`](BaseError.md).[`toJSON`](BaseError.md#tojson)
-
-#### 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`
-
-Create .stack property on a target object
-
-#### Parameters
-
-• **targetObject**: `object`
-
-• **constructorOpt?**: `Function`
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace)
-
-#### Defined in
-
-node\_modules/.pnpm/@types+node@22.7.6/node\_modules/@types/node/globals.d.ts:136
-
-***
-
-### create()
-
-> `static` **create**(`__namedParameters`): [`CommonError`](CommonError.md)
-
-#### Parameters
-
-• **\_\_namedParameters**
-
-• **\_\_namedParameters.code?**: `string` \| `number`
-
-• **\_\_namedParameters.data?**: `any`
-
-• **\_\_namedParameters.error**: `string`
-
-• **\_\_namedParameters.name?**: `string`
-
-#### Returns
-
-[`CommonError`](CommonError.md)
-
-#### Overrides
-
-[`BaseError`](BaseError.md).[`create`](BaseError.md#create)
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:96
-
-***
-
-### createErrorClass()
-
-> `static` **createErrorClass**(`aType`, `aErrorCode`?, `ParentErrorClass`?): *typeof* [`BaseError`](BaseError.md)
-
-Create an Error Class
-
-#### Parameters
-
-• **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)
-
-the new Error Class
-
-#### Inherited from
-
-[`BaseError`](BaseError.md).[`createErrorClass`](BaseError.md#createerrorclass)
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:66

package/docs/classes/ConfigFile.md

@@ -1,333 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / ConfigFile
-
-# Class: ConfigFile
-
-## Constructors
-
-### new ConfigFile()
-
-> **new ConfigFile**(`aOptions`?): [`ConfigFile`](ConfigFile.md)
-
-#### Parameters
-
-• **aOptions?**: `IConfigOptions`
-
-#### Returns
-
-[`ConfigFile`](ConfigFile.md)
-
-#### Defined in
-
-node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:42
-
-### new ConfigFile()
-
-> **new ConfigFile**(`aPath`, `aOptions`?): [`ConfigFile`](ConfigFile.md)
-
-#### Parameters
-
-• **aPath**: `string`
-
-• **aOptions?**: `IConfigOptions`
-
-#### Returns
-
-[`ConfigFile`](ConfigFile.md)
-
-#### Defined in
-
-node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:43
-
-## Properties
-
-### configurators
-
-> **configurators**: `IConfigurator`
-
-#### Defined in
-
-node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:37
-
-***
-
-### fs
-
-> **fs**: `IFileSystem`
-
-#### Defined in
-
-node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:38
-
-***
-
-### path
-
-> **path**: `any`
-
-#### Defined in
-
-node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:39
-
-***
-
-### readFile
-
-> **readFile**: `any`
-
-#### Defined in
-
-node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:40
-
-## Methods
-
-### load()
-
-#### load(aPath, done)
-
-> **load**(`aPath`, `done`): `void`
-
-##### Parameters
-
-• **aPath**: `string`
-
-• **done**: `ConfigCallBackFn`
-
-##### Returns
-
-`void`
-
-##### Defined in
-
-node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:44
-
-#### load(done)
-
-> **load**(`done`): `void`
-
-##### Parameters
-
-• **done**: `ConfigCallBackFn`
-
-##### Returns
-
-`void`
-
-##### Defined in
-
-node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:45
-
-#### load(aPath, aOptions, done)
-
-> **load**(`aPath`, `aOptions`, `done`): `void`
-
-##### Parameters
-
-• **aPath**: `string`
-
-• **aOptions**: `IConfigOptions`
-
-• **done**: `ConfigCallBackFn`
-
-##### Returns
-
-`void`
-
-##### Defined in
-
-node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:46
-
-#### load(aPath, aOptions)
-
-> **load**(`aPath`, `aOptions`?): `Promise`\<`any`\>
-
-##### Parameters
-
-• **aPath**: `string`
-
-• **aOptions?**: `IConfigOptions`
-
-##### Returns
-
-`Promise`\<`any`\>
-
-##### Defined in
-
-node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:47
-
-#### load(aOptions)
-
-> **load**(`aOptions`?): `Promise`\<`any`\>
-
-##### Parameters
-
-• **aOptions?**: `IConfigOptions`
-
-##### Returns
-
-`Promise`\<`any`\>
-
-##### Defined in
-
-node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:48
-
-***
-
-### loadSync()
-
-#### loadSync(aPath, aOptions)
-
-> **loadSync**(`aPath`, `aOptions`?): `any`
-
-##### Parameters
-
-• **aPath**: `string`
-
-• **aOptions?**: `IConfigOptions`
-
-##### Returns
-
-`any`
-
-##### Defined in
-
-node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:49
-
-#### loadSync(aOptions)
-
-> **loadSync**(`aOptions`?): `any`
-
-##### Parameters
-
-• **aOptions?**: `IConfigOptions`
-
-##### Returns
-
-`any`
-
-##### Defined in
-
-node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:50
-
-***
-
-### load()
-
-#### load(aPath, aOptions)
-
-> `static` **load**(`aPath`, `aOptions`?): `Promise`\<`any`\>
-
-##### Parameters
-
-• **aPath**: `string`
-
-• **aOptions?**: `IConfigOptions`
-
-##### Returns
-
-`Promise`\<`any`\>
-
-##### Defined in
-
-node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:32
-
-#### load(aPath, aOptions, done)
-
-> `static` **load**(`aPath`, `aOptions`, `done`): `void` \| `Promise`\<`any`\>
-
-##### Parameters
-
-• **aPath**: `string`
-
-• **aOptions**: `IConfigOptions`
-
-• **done**: `true` \| `ConfigCallBackFn`
-
-##### Returns
-
-`void` \| `Promise`\<`any`\>
-
-##### Defined in
-
-node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:33
-
-#### load(aPath, done)
-
-> `static` **load**(`aPath`, `done`): `void` \| `Promise`\<`any`\>
-
-##### Parameters
-
-• **aPath**: `string`
-
-• **done**: `true` \| `ConfigCallBackFn`
-
-##### Returns
-
-`void` \| `Promise`\<`any`\>
-
-##### Defined in
-
-node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:34
-
-***
-
-### loadSync()
-
-> `static` **loadSync**(`aPath`, `aOptions`?): `any`
-
-#### Parameters
-
-• **aPath**: `string`
-
-• **aOptions?**: `IConfigOptions`
-
-#### Returns
-
-`any`
-
-#### Defined in
-
-node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:35
-
-***
-
-### register()
-
-> `static` **register**(`aExts`, `aProcess`, `aConfigurators`?): `any`
-
-#### Parameters
-
-• **aExts**: `string` \| `string`[]
-
-• **aProcess**: `ConfigAsyncProcessFn`
-
-• **aConfigurators?**: `IConfigurator`
-
-#### Returns
-
-`any`
-
-#### Defined in
-
-node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:29
-
-***
-
-### setFileSystem()
-
-> `static` **setFileSystem**(`aFileSystem`): `any`
-
-#### Parameters
-
-• **aFileSystem**: `IFileSystem`
-
-#### Returns
-
-`any`
-
-#### Defined in
-
-node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:30