@zeix/le-truc 0.15.0

package/docs-src/api/classes/MissingElementError.md

@@ -0,0 +1,307 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / MissingElementError
+
+# Class: MissingElementError
+
+Defined in: [src/errors.ts:84](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/errors.ts#L84)
+
+Error thrown when a required desacendent element does not exist in a component's DOM subtree
+
+## Since
+
+0.14.0
+
+## Extends
+
+- `Error`
+
+## Constructors
+
+### Constructor
+
+> **new MissingElementError**(`host`, `selector`, `required`): `MissingElementError`
+
+Defined in: [src/errors.ts:90](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/errors.ts#L90)
+
+#### Parameters
+
+##### host
+
+`HTMLElement`
+
+Host component
+
+##### selector
+
+`string`
+
+Selector used to find the elements
+
+##### required
+
+`string`
+
+Explanation why the element is required
+
+#### Returns
+
+`MissingElementError`
+
+#### Overrides
+
+`Error.constructor`
+
+## Properties
+
+### cause?
+
+> `optional` **cause**: `unknown`
+
+Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26
+
+The cause of the error.
+
+#### Inherited from
+
+`Error.cause`
+
+***
+
+### message
+
+> **message**: `string`
+
+Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077
+
+#### Inherited from
+
+`Error.message`
+
+***
+
+### name
+
+> **name**: `string`
+
+Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076
+
+#### Inherited from
+
+`Error.name`
+
+***
+
+### stack?
+
+> `optional` **stack**: `string`
+
+Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078
+
+#### Inherited from
+
+`Error.stack`
+
+***
+
+### stackTraceLimit
+
+> `static` **stackTraceLimit**: `number`
+
+Defined in: node\_modules/@types/node/globals.d.ts:68
+
+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
+
+`Error.stackTraceLimit`
+
+## Methods
+
+### captureStackTrace()
+
+#### Call Signature
+
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Defined in: node\_modules/@types/node/globals.d.ts:52
+
+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
+
+`Error.captureStackTrace`
+
+#### Call Signature
+
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Defined in: node\_modules/bun-types/globals.d.ts:1043
+
+Create .stack property on a target object
+
+##### Parameters
+
+###### targetObject
+
+`object`
+
+###### constructorOpt?
+
+`Function`
+
+##### Returns
+
+`void`
+
+##### Inherited from
+
+`Error.captureStackTrace`
+
+***
+
+### isError()
+
+#### Call Signature
+
+> `static` **isError**(`error`): `error is Error`
+
+Defined in: node\_modules/typescript/lib/lib.esnext.error.d.ts:23
+
+Indicates whether the argument provided is a built-in Error instance or not.
+
+##### Parameters
+
+###### error
+
+`unknown`
+
+##### Returns
+
+`error is Error`
+
+##### Inherited from
+
+`Error.isError`
+
+#### Call Signature
+
+> `static` **isError**(`value`): `value is Error`
+
+Defined in: node\_modules/bun-types/globals.d.ts:1038
+
+Check if a value is an instance of Error
+
+##### Parameters
+
+###### value
+
+`unknown`
+
+The value to check
+
+##### Returns
+
+`value is Error`
+
+True if the value is an instance of Error, false otherwise
+
+##### Inherited from
+
+`Error.isError`
+
+***
+
+### prepareStackTrace()
+
+> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`
+
+Defined in: node\_modules/@types/node/globals.d.ts:56
+
+#### Parameters
+
+##### err
+
+`Error`
+
+##### stackTraces
+
+`CallSite`[]
+
+#### Returns
+
+`any`
+
+#### See
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+#### Inherited from
+
+`Error.prepareStackTrace`

package/docs-src/api/classes/NullishSignalValueError.md

@@ -0,0 +1,299 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / NullishSignalValueError
+
+# Class: NullishSignalValueError
+
+Defined in: node\_modules/@zeix/cause-effect/types/src/errors.d.ts:10
+
+## Name
+
+Le Truc
+
+## Version
+
+0.15.0
+
+## Author
+
+Esther Brunner
+
+## Extends
+
+- `TypeError`
+
+## Constructors
+
+### Constructor
+
+> **new NullishSignalValueError**(`where`): `NullishSignalValueError`
+
+Defined in: node\_modules/@zeix/cause-effect/types/src/errors.d.ts:11
+
+#### Parameters
+
+##### where
+
+`string`
+
+#### Returns
+
+`NullishSignalValueError`
+
+#### Overrides
+
+`TypeError.constructor`
+
+## Properties
+
+### cause?
+
+> `optional` **cause**: `unknown`
+
+Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26
+
+The cause of the error.
+
+#### Inherited from
+
+`TypeError.cause`
+
+***
+
+### message
+
+> **message**: `string`
+
+Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077
+
+#### Inherited from
+
+`TypeError.message`
+
+***
+
+### name
+
+> **name**: `string`
+
+Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076
+
+#### Inherited from
+
+`TypeError.name`
+
+***
+
+### stack?
+
+> `optional` **stack**: `string`
+
+Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078
+
+#### Inherited from
+
+`TypeError.stack`
+
+***
+
+### stackTraceLimit
+
+> `static` **stackTraceLimit**: `number`
+
+Defined in: node\_modules/@types/node/globals.d.ts:68
+
+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
+
+`TypeError.stackTraceLimit`
+
+## Methods
+
+### captureStackTrace()
+
+#### Call Signature
+
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Defined in: node\_modules/@types/node/globals.d.ts:52
+
+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
+
+`TypeError.captureStackTrace`
+
+#### Call Signature
+
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Defined in: node\_modules/bun-types/globals.d.ts:1043
+
+Create .stack property on a target object
+
+##### Parameters
+
+###### targetObject
+
+`object`
+
+###### constructorOpt?
+
+`Function`
+
+##### Returns
+
+`void`
+
+##### Inherited from
+
+`TypeError.captureStackTrace`
+
+***
+
+### isError()
+
+#### Call Signature
+
+> `static` **isError**(`error`): `error is Error`
+
+Defined in: node\_modules/typescript/lib/lib.esnext.error.d.ts:23
+
+Indicates whether the argument provided is a built-in Error instance or not.
+
+##### Parameters
+
+###### error
+
+`unknown`
+
+##### Returns
+
+`error is Error`
+
+##### Inherited from
+
+`TypeError.isError`
+
+#### Call Signature
+
+> `static` **isError**(`value`): `value is Error`
+
+Defined in: node\_modules/bun-types/globals.d.ts:1038
+
+Check if a value is an instance of Error
+
+##### Parameters
+
+###### value
+
+`unknown`
+
+The value to check
+
+##### Returns
+
+`value is Error`
+
+True if the value is an instance of Error, false otherwise
+
+##### Inherited from
+
+`TypeError.isError`
+
+***
+
+### prepareStackTrace()
+
+> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`
+
+Defined in: node\_modules/@types/node/globals.d.ts:56
+
+#### Parameters
+
+##### err
+
+`Error`
+
+##### stackTraces
+
+`CallSite`[]
+
+#### Returns
+
+`any`
+
+#### See
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+#### Inherited from
+
+`TypeError.prepareStackTrace`