@oliversalzburg/js-utils 0.0.7 → 0.0.8

package/docs/classes/UnexpectedNilError.md

@@ -1,169 +0,0 @@
-[@oliversalzburg/js-utils](../README.md) / [Exports](../modules.md) / UnexpectedNilError
-
-# Class: UnexpectedNilError
-
-Thrown when an unexpected nil value was encountered.
-
-## Hierarchy
-
--   `Error`
-
-    ↳ **`UnexpectedNilError`**
-
-## Constructors
-
-### constructor
-
-• **new UnexpectedNilError**(`message?`): [`UnexpectedNilError`](UnexpectedNilError.md)
-
-Constructs a new {UnexpectedNilError}.
-
-#### Parameters
-
-| Name      | Type     | Default value            | Description        |
-| :-------- | :------- | :----------------------- | :----------------- |
-| `message` | `string` | `"unexpected nil value"` | The error message. |
-
-#### Returns
-
-[`UnexpectedNilError`](UnexpectedNilError.md)
-
-#### Overrides
-
-Error.constructor
-
-#### Defined in
-
-[nil.ts:44](https://github.com/oliversalzburg/js-utils/blob/293b24f/source/nil.ts#L44)
-
-## Properties
-
-### cause
-
-• `Optional` **cause**: `unknown`
-
-#### Inherited from
-
-Error.cause
-
-#### Defined in
-
-../node_modules/typescript/lib/lib.es2022.error.d.ts:24
-
----
-
-### message
-
-• **message**: `string`
-
-#### Inherited from
-
-Error.message
-
-#### Defined in
-
-../node_modules/typescript/lib/lib.es5.d.ts:1068
-
----
-
-### name
-
-• **name**: `string`
-
-#### Inherited from
-
-Error.name
-
-#### Defined in
-
-../node_modules/typescript/lib/lib.es5.d.ts:1067
-
----
-
-### stack
-
-• `Optional` **stack**: `string`
-
-#### Inherited from
-
-Error.stack
-
-#### Defined in
-
-../node_modules/typescript/lib/lib.es5.d.ts:1069
-
----
-
-### prepareStackTrace
-
-▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
-
-#### Type declaration
-
-▸ (`err`, `stackTraces`): `any`
-
-Optional override for formatting stack traces
-
-##### Parameters
-
-| Name          | Type         |
-| :------------ | :----------- |
-| `err`         | `Error`      |
-| `stackTraces` | `CallSite`[] |
-
-##### Returns
-
-`any`
-
-**`See`**
-
-https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-
-#### Inherited from
-
-Error.prepareStackTrace
-
-#### Defined in
-
-../node_modules/@types/node/globals.d.ts:11
-
----
-
-### stackTraceLimit
-
-▪ `Static` **stackTraceLimit**: `number`
-
-#### Inherited from
-
-Error.stackTraceLimit
-
-#### Defined in
-
-../node_modules/@types/node/globals.d.ts:13
-
-## Methods
-
-### captureStackTrace
-
-▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
-
-Create .stack property on a target object
-
-#### Parameters
-
-| Name              | Type       |
-| :---------------- | :--------- |
-| `targetObject`    | `object`   |
-| `constructorOpt?` | `Function` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-Error.captureStackTrace
-
-#### Defined in
-
-../node_modules/@types/node/globals.d.ts:4

package/docs/classes/UnknownError.md

@@ -1,280 +0,0 @@
-[@oliversalzburg/js-utils](../README.md) / [Exports](../modules.md) / UnknownError
-
-# Class: UnknownError
-
-Used when an unknown, non-`Error`-like object was caught and converted into a
-real `Error` instance.
-Like when you catch a `throw "boom"`, we will convert the caught `"boom"`
-into an `UnknownError`.
-To enrich an `Error`-like object that was caught, use the [InternalError](InternalError.md).
-
-## Hierarchy
-
--   [`AbstractError`](AbstractError.md)
-
-    ↳ **`UnknownError`**
-
-## Constructors
-
-### constructor
-
-• **new UnknownError**(`message`, `status?`): [`UnknownError`](UnknownError.md)
-
-Constructs a new [UnknownError](UnknownError.md).
-
-#### Parameters
-
-| Name      | Type     | Default value | Description                     |
-| :-------- | :------- | :------------ | :------------------------------ |
-| `message` | `string` | `undefined`   | The main error message.         |
-| `status`  | `number` | `500`         | The HTTP status code to return. |
-
-#### Returns
-
-[`UnknownError`](UnknownError.md)
-
-#### Overrides
-
-[AbstractError](AbstractError.md).[constructor](AbstractError.md#constructor)
-
-#### Defined in
-
-[errors/UnknownError.ts:16](https://github.com/oliversalzburg/js-utils/blob/293b24f/source/errors/UnknownError.ts#L16)
-
-## Properties
-
-### cause
-
-• `Optional` **cause**: `unknown`
-
-#### Inherited from
-
-[AbstractError](AbstractError.md).[cause](AbstractError.md#cause)
-
-#### Defined in
-
-../node_modules/typescript/lib/lib.es2022.error.d.ts:24
-
----
-
-### code
-
-• **code**: `string`
-
-An application-unique, readable error code.
-
-#### Inherited from
-
-[AbstractError](AbstractError.md).[code](AbstractError.md#code)
-
-#### Defined in
-
-[errors/AbstractError.ts:29](https://github.com/oliversalzburg/js-utils/blob/293b24f/source/errors/AbstractError.ts#L29)
-
----
-
-### info
-
-• **info**: [`Maybe`](../modules.md#maybe)\<`string`\>
-
-A user-friendly error message that may be transported to the client.
-
-**`Deprecated`**
-
-User-friendly errors should be read from `extensions`.
-
-#### Inherited from
-
-[AbstractError](AbstractError.md).[info](AbstractError.md#info)
-
-#### Defined in
-
-[errors/AbstractError.ts:24](https://github.com/oliversalzburg/js-utils/blob/293b24f/source/errors/AbstractError.ts#L24)
-
----
-
-### inner
-
-• **inner**: [`Maybe`](../modules.md#maybe)\<`Error`\>
-
-Another error that should be transported with this error.
-
-**`Deprecated`**
-
-We don't make use of this or interpret nested errors at all.
-
-#### Inherited from
-
-[AbstractError](AbstractError.md).[inner](AbstractError.md#inner)
-
-#### Defined in
-
-[errors/AbstractError.ts:18](https://github.com/oliversalzburg/js-utils/blob/293b24f/source/errors/AbstractError.ts#L18)
-
----
-
-### message
-
-• **message**: `string`
-
-#### Inherited from
-
-[AbstractError](AbstractError.md).[message](AbstractError.md#message)
-
-#### Defined in
-
-../node_modules/typescript/lib/lib.es5.d.ts:1068
-
----
-
-### name
-
-• **name**: `string`
-
-#### Inherited from
-
-[AbstractError](AbstractError.md).[name](AbstractError.md#name)
-
-#### Defined in
-
-../node_modules/typescript/lib/lib.es5.d.ts:1067
-
----
-
-### stack
-
-• `Optional` **stack**: `string`
-
-#### Inherited from
-
-[AbstractError](AbstractError.md).[stack](AbstractError.md#stack)
-
-#### Defined in
-
-../node_modules/typescript/lib/lib.es5.d.ts:1069
-
----
-
-### status
-
-• **status**: `number`
-
-The HTTP status code to associate with this error.
-
-**`Deprecated`**
-
-We no longer respond to HTTP requests with error-specifc
-status codes.
-
-#### Inherited from
-
-[AbstractError](AbstractError.md).[status](AbstractError.md#status)
-
-#### Defined in
-
-[errors/AbstractError.ts:12](https://github.com/oliversalzburg/js-utils/blob/293b24f/source/errors/AbstractError.ts#L12)
-
----
-
-### prepareStackTrace
-
-▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
-
-#### Type declaration
-
-▸ (`err`, `stackTraces`): `any`
-
-Optional override for formatting stack traces
-
-##### Parameters
-
-| Name          | Type         |
-| :------------ | :----------- |
-| `err`         | `Error`      |
-| `stackTraces` | `CallSite`[] |
-
-##### Returns
-
-`any`
-
-**`See`**
-
-https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-
-#### Inherited from
-
-[AbstractError](AbstractError.md).[prepareStackTrace](AbstractError.md#preparestacktrace)
-
-#### Defined in
-
-../node_modules/@types/node/globals.d.ts:11
-
----
-
-### stackTraceLimit
-
-▪ `Static` **stackTraceLimit**: `number`
-
-#### Inherited from
-
-[AbstractError](AbstractError.md).[stackTraceLimit](AbstractError.md#stacktracelimit)
-
-#### Defined in
-
-../node_modules/@types/node/globals.d.ts:13
-
-## Methods
-
-### captureStackTrace
-
-▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
-
-Create .stack property on a target object
-
-#### Parameters
-
-| Name              | Type       |
-| :---------------- | :--------- |
-| `targetObject`    | `object`   |
-| `constructorOpt?` | `Function` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[AbstractError](AbstractError.md).[captureStackTrace](AbstractError.md#capturestacktrace)
-
-#### Defined in
-
-../node_modules/@types/node/globals.d.ts:4
-
----
-
-### isAbstractError
-
-▸ **isAbstractError**(`error`, `allowForeignModule?`): error is AbstractError
-
-Checks if an object is an instance of [AbstractError](AbstractError.md), or one of its subclasses.
-
-#### Parameters
-
-| Name                 | Type      | Default value | Description                                                                                                                                                 |
-| :------------------- | :-------- | :------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `error`              | `unknown` | `undefined`   | The object to check.                                                                                                                                        |
-| `allowForeignModule` | `boolean` | `true`        | Only check for similar looking error codes. You're going to want to use this if you're dealing with a setup where multiple versions of js-utils are loaded. |
-
-#### Returns
-
-error is AbstractError
-
-`true` if the object is an [AbstractError](AbstractError.md), `false` otherwise.
-
-#### Inherited from
-
-[AbstractError](AbstractError.md).[isAbstractError](AbstractError.md#isabstracterror)
-
-#### Defined in
-
-[errors/AbstractError.ts:58](https://github.com/oliversalzburg/js-utils/blob/293b24f/source/errors/AbstractError.ts#L58)

package/docs/classes/Vector2.md

@@ -1,79 +0,0 @@
-[@oliversalzburg/js-utils](../README.md) / [Exports](../modules.md) / Vector2
-
-# Class: Vector2
-
-A vector with 2 components.
-
-## Hierarchy
-
--   **`Vector2`**
-
-    ↳ [`Vector3`](Vector3.md)
-
-## Constructors
-
-### constructor
-
-• **new Vector2**(`x`, `y`): [`Vector2`](Vector2.md)
-
-Constructs a new [Vector2](Vector2.md).
-
-#### Parameters
-
-| Name | Type     | Description      |
-| :--- | :------- | :--------------- |
-| `x`  | `number` | The X component. |
-| `y`  | `number` | The Y component. |
-
-#### Returns
-
-[`Vector2`](Vector2.md)
-
-#### Defined in
-
-[math/vector.ts:13](https://github.com/oliversalzburg/js-utils/blob/293b24f/source/math/vector.ts#L13)
-
-## Properties
-
-### x
-
-• **x**: `number`
-
-#### Defined in
-
-[math/vector.ts:5](https://github.com/oliversalzburg/js-utils/blob/293b24f/source/math/vector.ts#L5)
-
----
-
-### y
-
-• **y**: `number`
-
-#### Defined in
-
-[math/vector.ts:6](https://github.com/oliversalzburg/js-utils/blob/293b24f/source/math/vector.ts#L6)
-
-## Methods
-
-### dot2
-
-▸ **dot2**(`x`, `y`): `number`
-
-Returns the dot product between the two vectors.
-
-#### Parameters
-
-| Name | Type     | Description                          |
-| :--- | :------- | :----------------------------------- |
-| `x`  | `number` | The X component of the other vector. |
-| `y`  | `number` | The Y component of the other vector. |
-
-#### Returns
-
-`number`
-
-The dot product between the two vectors.
-
-#### Defined in
-
-[math/vector.ts:24](https://github.com/oliversalzburg/js-utils/blob/293b24f/source/math/vector.ts#L24)

package/docs/classes/Vector3.md

@@ -1,106 +0,0 @@
-[@oliversalzburg/js-utils](../README.md) / [Exports](../modules.md) / Vector3
-
-# Class: Vector3
-
-A vector with 3 components.
-
-## Hierarchy
-
--   [`Vector2`](Vector2.md)
-
-    ↳ **`Vector3`**
-
-## Constructors
-
-### constructor
-
-• **new Vector3**(`x`, `y`, `z`): [`Vector3`](Vector3.md)
-
-Constructs a new [Vector3](Vector3.md).
-
-#### Parameters
-
-| Name | Type     | Description      |
-| :--- | :------- | :--------------- |
-| `x`  | `number` | The X component. |
-| `y`  | `number` | The Y component. |
-| `z`  | `number` | The Z component. |
-
-#### Returns
-
-[`Vector3`](Vector3.md)
-
-#### Overrides
-
-[Vector2](Vector2.md).[constructor](Vector2.md#constructor)
-
-#### Defined in
-
-[math/vector.ts:41](https://github.com/oliversalzburg/js-utils/blob/293b24f/source/math/vector.ts#L41)
-
-## Properties
-
-### x
-
-• **x**: `number`
-
-#### Inherited from
-
-[Vector2](Vector2.md).[x](Vector2.md#x)
-
-#### Defined in
-
-[math/vector.ts:5](https://github.com/oliversalzburg/js-utils/blob/293b24f/source/math/vector.ts#L5)
-
----
-
-### y
-
-• **y**: `number`
-
-#### Inherited from
-
-[Vector2](Vector2.md).[y](Vector2.md#y)
-
-#### Defined in
-
-[math/vector.ts:6](https://github.com/oliversalzburg/js-utils/blob/293b24f/source/math/vector.ts#L6)
-
----
-
-### z
-
-• **z**: `number`
-
-#### Defined in
-
-[math/vector.ts:33](https://github.com/oliversalzburg/js-utils/blob/293b24f/source/math/vector.ts#L33)
-
-## Methods
-
-### dot2
-
-▸ **dot2**(`x`, `y`): `number`
-
-Returns the dot product between the two vectors.
-
-#### Parameters
-
-| Name | Type     | Description                          |
-| :--- | :------- | :----------------------------------- |
-| `x`  | `number` | The X component of the other vector. |
-| `y`  | `number` | The Y component of the other vector. |
-
-#### Returns
-
-`number`
-
-The dot product between the two vectors.
-
-#### Inherited from
-
-[Vector2](Vector2.md).[dot2](Vector2.md#dot2)
-
-#### Defined in
-
-[math/vector.ts:24](https://github.com/oliversalzburg/js-utils/blob/293b24f/source/math/vector.ts#L24)