@isdk/ai-tool 0.5.8 → 0.7.0

package/docs/api/classes/AlreadyExistsError.md

@@ -0,0 +1,431 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / AlreadyExistsError
+
+# Class: AlreadyExistsError
+
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@isdk+common-error@0.2.0/node\_modules/@isdk/common-error/dist/index.d.ts:149
+
+Represents an error when a requested resource already exists.
+Inherits from BaseError.
+
+## Example
+
+```ts
+throw new AlreadyExistsError('user', { id: 123 })
+```
+
+## Extends
+
+- [`CommonError`](CommonError.md)
+
+## Constructors
+
+### new AlreadyExistsError()
+
+> **new AlreadyExistsError**(`what`, `name`?): [`AlreadyExistsError`](AlreadyExistsError.md)
+
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@isdk+common-error@0.2.0/node\_modules/@isdk/common-error/dist/index.d.ts:151
+
+#### Parameters
+
+##### what
+
+`string` | `number`
+
+##### name?
+
+`string` | `Record`\<`string`, `any`\>
+
+#### Returns
+
+[`AlreadyExistsError`](AlreadyExistsError.md)
+
+#### Overrides
+
+[`CommonError`](CommonError.md).[`constructor`](CommonError.md#constructors)
+
+## Properties
+
+### caller
+
+> **caller**: `string`
+
+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.
+
+#### Inherited from
+
+[`CommonError`](CommonError.md).[`caller`](CommonError.md#caller)
+
+***
+
+### cause?
+
+> `optional` **cause**: `unknown`
+
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26
+
+#### Inherited from
+
+[`CommonError`](CommonError.md).[`cause`](CommonError.md#cause)
+
+***
+
+### code
+
+> **code**: `ErrorCodeType`
+
+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
+
+#### Inherited from
+
+[`CommonError`](CommonError.md).[`code`](CommonError.md#code)
+
+***
+
+### data?
+
+> `optional` **data**: `any`
+
+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.
+
+#### Inherited from
+
+[`CommonError`](CommonError.md).[`data`](CommonError.md#data)
+
+***
+
+### message
+
+> **message**: `string`
+
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1077
+
+#### Inherited from
+
+[`CommonError`](CommonError.md).[`message`](CommonError.md#message-1)
+
+***
+
+### name
+
+> **name**: `string`
+
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1076
+
+#### Inherited from
+
+[`CommonError`](CommonError.md).[`name`](CommonError.md#name-1)
+
+***
+
+### stack?
+
+> `optional` **stack**: `string`
+
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1078
+
+#### Inherited from
+
+[`CommonError`](CommonError.md).[`stack`](CommonError.md#stack)
+
+***
+
+### code
+
+> `static` **code**: [`ErrorCode`](../enumerations/ErrorCode.md)
+
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@isdk+common-error@0.2.0/node\_modules/@isdk/common-error/dist/index.d.ts:150
+
+The error code associated with the error.
+
+#### Overrides
+
+[`CommonError`](CommonError.md).[`code`](CommonError.md#code-1)
+
+***
+
+### stackTraceLimit
+
+> `static` **stackTraceLimit**: `number`
+
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@types+node@24.3.0/node\_modules/@types/node/globals.d.ts:162
+
+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)`).
+
+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.
+
+If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
+
+#### Inherited from
+
+[`CommonError`](CommonError.md).[`stackTraceLimit`](CommonError.md#stacktracelimit)
+
+## Methods
+
+### fromJSON()
+
+> **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:104
+
+#### Parameters
+
+##### json
+
+`any`
+
+#### Returns
+
+[`BaseError`](BaseError.md)
+
+#### Inherited from
+
+[`CommonError`](CommonError.md).[`fromJSON`](CommonError.md#fromjson)
+
+***
+
+### toJSON()
+
+> **toJSON**(): `any`
+
+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.
+
+#### Returns
+
+`any`
+
+A JSON representation of the error.
+
+#### Inherited from
+
+[`CommonError`](CommonError.md).[`toJSON`](CommonError.md#tojson)
+
+***
+
+### captureStackTrace()
+
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
+
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@types+node@24.3.0/node\_modules/@types/node/globals.d.ts:146
+
+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
+
+##### targetObject
+
+`object`
+
+##### constructorOpt?
+
+`Function`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`CommonError`](CommonError.md).[`captureStackTrace`](CommonError.md#capturestacktrace)
+
+***
+
+### create()
+
+> `static` **create**(`__namedParameters`): [`CommonError`](CommonError.md)
+
+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
+
+##### \_\_namedParameters
+
+###### code?
+
+`string` \| `number`
+
+###### data?
+
+`any`
+
+###### error
+
+`string`
+
+###### name?
+
+`string`
+
+#### Returns
+
+[`CommonError`](CommonError.md)
+
+#### Inherited from
+
+[`CommonError`](CommonError.md).[`create`](CommonError.md#create)
+
+***
+
+### createErrorClass()
+
+> `static` **createErrorClass**(`aType`, `aErrorCode`?, `ParentErrorClass`?): *typeof* [`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:66
+
+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
+
+[`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)