@isdk/ai-tool 0.4.0 → 0.5.1

package/docs/classes/NotFoundError.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -6,6 +6,8 @@
 
 # Class: NotFoundError
 
+Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:125
+
 Represents an error when a requested resource is not found.
 Inherits from BaseError.
 
@@ -25,11 +27,17 @@ throw new NotFoundError('user', { id: 123 })
 
 > **new NotFoundError**(`what`, `name`?): [`NotFoundError`](NotFoundError.md)
 
+Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:127
+
 #### Parameters
 
-• **what**: `string` \| `number`
+##### what
+
+`string` | `number`
 
-• **name?**: `string` \| `Record`\<`string`, `any`\>
+##### name?
+
+`string` | `Record`\<`string`, `any`\>
 
 #### Returns
 
@@ -39,85 +47,71 @@ throw new NotFoundError('user', { id: 123 })
 
 [`CommonError`](CommonError.md).[`constructor`](CommonError.md#constructors)
 
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:127
-
 ## Properties
 
 ### caller
 
 > **caller**: `string`
 
+Defined in: 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.
 
 #### Inherited from
 
 [`CommonError`](CommonError.md).[`caller`](CommonError.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`
 
+Defined in: node\_modules/.pnpm/typescript@5.7.2/node\_modules/typescript/lib/lib.es2022.error.d.ts:26
+
 #### Inherited from
 
 [`CommonError`](CommonError.md).[`cause`](CommonError.md#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
 
 #### Inherited from
 
 [`CommonError`](CommonError.md).[`code`](CommonError.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`
 
+Defined in: 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.
 
 #### Inherited from
 
 [`CommonError`](CommonError.md).[`data`](CommonError.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
-
-[`CommonError`](CommonError.md).[`message`](CommonError.md#message)
+Defined in: node\_modules/.pnpm/typescript@5.7.2/node\_modules/typescript/lib/lib.es5.d.ts:1077
 
-#### Defined in
+#### Inherited from
 
-node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1077
+[`CommonError`](CommonError.md).[`message`](CommonError.md#message-1)
 
 ***
 
@@ -125,13 +119,11 @@ node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1
 
 > **name**: `string`
 
-#### Inherited from
-
-[`CommonError`](CommonError.md).[`name`](CommonError.md#name)
+Defined in: node\_modules/.pnpm/typescript@5.7.2/node\_modules/typescript/lib/lib.es5.d.ts:1076
 
-#### Defined in
+#### Inherited from
 
-node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1076
+[`CommonError`](CommonError.md).[`name`](CommonError.md#name-1)
 
 ***
 
@@ -139,43 +131,45 @@ node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1
 
 > `optional` **stack**: `string`
 
+Defined in: node\_modules/.pnpm/typescript@5.7.2/node\_modules/typescript/lib/lib.es5.d.ts:1078
+
 #### Inherited from
 
 [`CommonError`](CommonError.md).[`stack`](CommonError.md#stack)
 
-#### Defined in
-
-node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1078
-
 ***
 
 ### code
 
 > `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:126
+
 The error code associated with the error.
 
 #### Overrides
 
 [`CommonError`](CommonError.md).[`code`](CommonError.md#code-1)
 
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:126
-
 ***
 
 ### 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`
+##### err
+
+`Error`
+
+##### stackTraces
 
-• **stackTraces**: `CallSite`[]
+`CallSite`[]
 
 #### Returns
 
@@ -189,35 +183,33 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
 
 [`CommonError`](CommonError.md).[`prepareStackTrace`](CommonError.md#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
 
 [`CommonError`](CommonError.md).[`stackTraceLimit`](CommonError.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)
 
+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.
 
@@ -231,16 +223,14 @@ A new BaseError instance.
 
 [`CommonError`](CommonError.md).[`fromJSON`](CommonError.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`
 
+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
@@ -253,23 +243,25 @@ A JSON representation of the error.
 
 [`CommonError`](CommonError.md).[`toJSON`](CommonError.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`
 
+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
 
@@ -279,27 +271,33 @@ Create .stack property on a target object
 
 [`CommonError`](CommonError.md).[`captureStackTrace`](CommonError.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)
 
+Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:96
+
 #### Parameters
 
-• **\_\_namedParameters**
+##### \_\_namedParameters
+
+###### code?
+
+`string` \| `number`
 
-• **\_\_namedParameters.code?**: `string` \| `number`
+###### data?
 
-• **\_\_namedParameters.data?**: `any`
+`any`
+
+###### error
 
-• **\_\_namedParameters.error**: `string`
+`string`
 
-• **\_\_namedParameters.name?**: `string`
+###### name?
+
+`string`
 
 #### Returns
 
@@ -309,27 +307,31 @@ node\_modules/.pnpm/@types+node@22.7.6/node\_modules/@types/node/globals.d.ts:13
 
 [`CommonError`](CommonError.md).[`create`](CommonError.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)
 
+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
 
@@ -342,7 +344,3 @@ the new Error Class
 #### Inherited from
 
 [`CommonError`](CommonError.md).[`createErrorClass`](CommonError.md#createerrorclass)
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:66