@zeix/le-truc 0.15.0

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

@@ -0,0 +1,303 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / StoreKeyReadonlyError
+
+# Class: StoreKeyReadonlyError
+
+Defined in: node\_modules/@zeix/cause-effect/types/src/errors.d.ts:19
+
+## Name
+
+Le Truc
+
+## Version
+
+0.15.0
+
+## Author
+
+Esther Brunner
+
+## Extends
+
+- `Error`
+
+## Constructors
+
+### Constructor
+
+> **new StoreKeyReadonlyError**(`key`, `value`): `StoreKeyReadonlyError`
+
+Defined in: node\_modules/@zeix/cause-effect/types/src/errors.d.ts:20
+
+#### Parameters
+
+##### key
+
+`string`
+
+##### value
+
+`string`
+
+#### Returns
+
+`StoreKeyReadonlyError`
+
+#### 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/functions/asBoolean.md

@@ -0,0 +1,21 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / asBoolean
+
+# Function: asBoolean()
+
+> **asBoolean**(): [`Parser`](../type-aliases/Parser.md)\<`boolean`, [`UI`](../type-aliases/UI.md)\>
+
+Defined in: [src/parsers/boolean.ts:11](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/parsers/boolean.ts#L11)
+
+Parse a boolean attribute as an actual boolean value
+
+## Returns
+
+[`Parser`](../type-aliases/Parser.md)\<`boolean`, [`UI`](../type-aliases/UI.md)\>
+
+## Since
+
+0.13.1

package/docs-src/api/functions/asEnum.md

@@ -0,0 +1,31 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / asEnum
+
+# Function: asEnum()
+
+> **asEnum**(`valid`): [`Parser`](../type-aliases/Parser.md)\<`string`, [`UI`](../type-aliases/UI.md)\>
+
+Defined in: [src/parsers/string.ts:24](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/parsers/string.ts#L24)
+
+Parse a string as a multi-state value (for example: ['true', 'false', 'mixed'], defaulting to the first valid option
+
+## Parameters
+
+### valid
+
+\[`string`, `...string[]`\]
+
+Array of valid values
+
+## Returns
+
+[`Parser`](../type-aliases/Parser.md)\<`string`, [`UI`](../type-aliases/UI.md)\>
+
+Parser function
+
+## Since
+
+0.9.0

package/docs-src/api/functions/asInteger.md

@@ -0,0 +1,39 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / asInteger
+
+# Function: asInteger()
+
+> **asInteger**\<`U`\>(`fallback?`): [`Parser`](../type-aliases/Parser.md)\<`number`, `U`\>
+
+Defined in: [src/parsers/number.ts:27](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/parsers/number.ts#L27)
+
+Parse a string as a number forced to integer with a fallback
+
+Supports hexadecimal and scientific notation
+
+## Type Parameters
+
+### U
+
+`U` *extends* [`UI`](../type-aliases/UI.md)
+
+## Parameters
+
+### fallback?
+
+[`Fallback`](../type-aliases/Fallback.md)\<`number`, `U`\> = `0`
+
+Fallback value or reader function
+
+## Returns
+
+[`Parser`](../type-aliases/Parser.md)\<`number`, `U`\>
+
+Parser function
+
+## Since
+
+0.11.0

package/docs-src/api/functions/asJSON.md

@@ -0,0 +1,49 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / asJSON
+
+# Function: asJSON()
+
+> **asJSON**\<`T`, `U`\>(`fallback`): [`Parser`](../type-aliases/Parser.md)\<`T`, `U`\>
+
+Defined in: [src/parsers/json.ts:14](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/parsers/json.ts#L14)
+
+Parse a string as a JSON serialized object with a fallback
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`
+
+### U
+
+`U` *extends* [`UI`](../type-aliases/UI.md)
+
+## Parameters
+
+### fallback
+
+[`Fallback`](../type-aliases/Fallback.md)\<`T`, `U`\>
+
+Fallback value or reader function
+
+## Returns
+
+[`Parser`](../type-aliases/Parser.md)\<`T`, `U`\>
+
+Parser function
+
+## Since
+
+0.11.0
+
+## Throws
+
+If the value and fallback are both null or undefined
+
+## Throws
+
+If value is not a valid JSON string

package/docs-src/api/functions/asNumber.md

@@ -0,0 +1,37 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / asNumber
+
+# Function: asNumber()
+
+> **asNumber**\<`U`\>(`fallback?`): [`Parser`](../type-aliases/Parser.md)\<`number`, `U`\>
+
+Defined in: [src/parsers/number.ts:51](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/parsers/number.ts#L51)
+
+Parse a string as a number with a fallback
+
+## Type Parameters
+
+### U
+
+`U` *extends* [`UI`](../type-aliases/UI.md)
+
+## Parameters
+
+### fallback?
+
+[`Fallback`](../type-aliases/Fallback.md)\<`number`, `U`\> = `0`
+
+Fallback value or reader function
+
+## Returns
+
+[`Parser`](../type-aliases/Parser.md)\<`number`, `U`\>
+
+Parser function
+
+## Since
+
+0.11.0

package/docs-src/api/functions/asString.md

@@ -0,0 +1,37 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / asString
+
+# Function: asString()
+
+> **asString**\<`U`\>(`fallback?`): [`Parser`](../type-aliases/Parser.md)\<`string`, `U`\>
+
+Defined in: [src/parsers/string.ts:12](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/parsers/string.ts#L12)
+
+Pass through string with a fallback
+
+## Type Parameters
+
+### U
+
+`U` *extends* [`UI`](../type-aliases/UI.md)
+
+## Parameters
+
+### fallback?
+
+[`Fallback`](../type-aliases/Fallback.md)\<`string`, `U`\> = `''`
+
+Fallback value or reader function
+
+## Returns
+
+[`Parser`](../type-aliases/Parser.md)\<`string`, `U`\>
+
+Parser function
+
+## Since
+
+0.11.0

package/docs-src/api/functions/createCollection.md

@@ -0,0 +1,83 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / createCollection
+
+# Function: createCollection()
+
+## Call Signature
+
+> **createCollection**\<`S`\>(`parent`, `selector`): [`Collection`](../type-aliases/Collection.md)\<`ElementFromSelector`\<`S`\>\>
+
+Defined in: [src/signals/collection.ts:67](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/signals/collection.ts#L67)
+
+Create a collection of elements from a parent node and a CSS selector.
+
+### Type Parameters
+
+#### S
+
+`S` *extends* `string`
+
+### Parameters
+
+#### parent
+
+`ParentNode`
+
+The parent node to search within
+
+#### selector
+
+`S`
+
+The CSS selector to match elements
+
+### Returns
+
+[`Collection`](../type-aliases/Collection.md)\<`ElementFromSelector`\<`S`\>\>
+
+A collection signal of elements
+
+### Since
+
+0.15.0
+
+## Call Signature
+
+> **createCollection**\<`E`\>(`parent`, `selector`): [`Collection`](../type-aliases/Collection.md)\<`E`\>
+
+Defined in: [src/signals/collection.ts:71](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/signals/collection.ts#L71)
+
+Create a collection of elements from a parent node and a CSS selector.
+
+### Type Parameters
+
+#### E
+
+`E` *extends* `Element`
+
+### Parameters
+
+#### parent
+
+`ParentNode`
+
+The parent node to search within
+
+#### selector
+
+`string`
+
+The CSS selector to match elements
+
+### Returns
+
+[`Collection`](../type-aliases/Collection.md)\<`E`\>
+
+A collection signal of elements
+
+### Since
+
+0.15.0

package/docs-src/api/functions/createSensor.md

@@ -0,0 +1,71 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / createSensor
+
+# Function: createSensor()
+
+> **createSensor**\<`T`, `P`, `U`, `K`\>(`init`, `key`, `events`): (`ui`) => [`Computed`](../type-aliases/Computed.md)\<`T`\>
+
+Defined in: [src/signals/sensor.ts:49](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/signals/sensor.ts#L49)
+
+Produce a computed signal from transformed event data
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`
+
+### P
+
+`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md)
+
+### U
+
+`U` *extends* [`UI`](../type-aliases/UI.md)
+
+### K
+
+`K` *extends* `string` \| `number` \| `symbol`
+
+## Parameters
+
+### init
+
+[`ParserOrFallback`](../type-aliases/ParserOrFallback.md)\<`T`, `U`\>
+
+Initial value, reader or parser
+
+### key
+
+`K`
+
+name of UI key
+
+### events
+
+[`SensorEvents`](../type-aliases/SensorEvents.md)\<`T`, `U`, [`ElementFromKey`](../type-aliases/ElementFromKey.md)\<`U`, `K`\>\>
+
+Transformation functions for events
+
+## Returns
+
+Extractor function for value from event
+
+> (`ui`): [`Computed`](../type-aliases/Computed.md)\<`T`\>
+
+### Parameters
+
+#### ui
+
+`U` & `object`
+
+### Returns
+
+[`Computed`](../type-aliases/Computed.md)\<`T`\>
+
+## Since
+
+0.14.0

package/docs-src/api/functions/dangerouslySetInnerHTML.md

@@ -0,0 +1,48 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / dangerouslySetInnerHTML
+
+# Function: dangerouslySetInnerHTML()
+
+> **dangerouslySetInnerHTML**\<`P`, `E`\>(`reactive`, `options`): [`Effect`](../type-aliases/Effect.md)\<`P`, `E`\>
+
+Defined in: [src/effects/html.ts:23](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/effects/html.ts#L23)
+
+Effect for setting the inner HTML of an element with optional Shadow DOM support.
+Provides security options for script execution and shadow root creation.
+
+## Type Parameters
+
+### P
+
+`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md)
+
+### E
+
+`E` *extends* `Element`
+
+## Parameters
+
+### reactive
+
+[`Reactive`](../type-aliases/Reactive.md)\<`string`, `P`, `E`\>
+
+Reactive value bound to the inner HTML content
+
+### options
+
+[`DangerouslySetInnerHTMLOptions`](../type-aliases/DangerouslySetInnerHTMLOptions.md) = `{}`
+
+Configuration options: shadowRootMode, allowScripts
+
+## Returns
+
+[`Effect`](../type-aliases/Effect.md)\<`P`, `E`\>
+
+Effect function that sets the inner HTML of the element
+
+## Since
+
+0.11.0