@zeix/le-truc 0.15.0

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

@@ -0,0 +1,52 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / setProperty
+
+# Function: setProperty()
+
+> **setProperty**\<`P`, `E`, `K`\>(`key`, `reactive`): [`Effect`](../type-aliases/Effect.md)\<`P`, `E`\>
+
+Defined in: [src/effects/property.ts:16](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/effects/property.ts#L16)
+
+Effect for setting a property on an element.
+Sets the specified property directly on the element object.
+
+## Type Parameters
+
+### P
+
+`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md)
+
+### E
+
+`E` *extends* `Element`
+
+### K
+
+`K` *extends* `string`
+
+## Parameters
+
+### key
+
+`K`
+
+Name of the property to set
+
+### reactive
+
+[`Reactive`](../type-aliases/Reactive.md)\<`E`\[`K`\] & `object`, `P`, `E`\> = `...`
+
+Reactive value bound to the property value (defaults to property name)
+
+## Returns
+
+[`Effect`](../type-aliases/Effect.md)\<`P`, `E`\>
+
+Effect function that sets the property on the element
+
+## Since
+
+0.8.0

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

@@ -0,0 +1,48 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / setStyle
+
+# Function: setStyle()
+
+> **setStyle**\<`P`, `E`\>(`prop`, `reactive`): [`Effect`](../type-aliases/Effect.md)\<`P`, `E`\>
+
+Defined in: [src/effects/style.ts:15](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/effects/style.ts#L15)
+
+Effect for setting a CSS style property on an element.
+Sets the specified style property with support for deletion via UNSET.
+
+## Type Parameters
+
+### P
+
+`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md)
+
+### E
+
+`E` *extends* `HTMLElement` \| `SVGElement` \| `MathMLElement`
+
+## Parameters
+
+### prop
+
+`string`
+
+Name of the CSS style property to set
+
+### reactive
+
+[`Reactive`](../type-aliases/Reactive.md)\<`string`, `P`, `E`\> = `...`
+
+Reactive value bound to the style property value (defaults to property name)
+
+## Returns
+
+[`Effect`](../type-aliases/Effect.md)\<`P`, `E`\>
+
+Effect function that sets the style property on the element
+
+## Since
+
+0.8.0

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

@@ -0,0 +1,42 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / setText
+
+# Function: setText()
+
+> **setText**\<`P`, `E`\>(`reactive`): [`Effect`](../type-aliases/Effect.md)\<`P`, `E`\>
+
+Defined in: [src/effects/text.ts:14](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/effects/text.ts#L14)
+
+Effect for setting the text content of an element.
+Replaces all child nodes (except comments) with a single text node.
+
+## 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 text content
+
+## Returns
+
+[`Effect`](../type-aliases/Effect.md)\<`P`, `E`\>
+
+Effect function that sets the text content of the element
+
+## Since
+
+0.8.0

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

@@ -0,0 +1,42 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / show
+
+# Function: show()
+
+> **show**\<`P`, `E`\>(`reactive`): [`Effect`](../type-aliases/Effect.md)\<`P`, `E`\>
+
+Defined in: [src/effects/property.ts:45](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/effects/property.ts#L45)
+
+Effect for controlling element visibility by setting the 'hidden' property.
+When the reactive value is true, the element is shown; when false, it's hidden.
+
+## Type Parameters
+
+### P
+
+`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md)
+
+### E
+
+`E` *extends* `HTMLElement` = `HTMLElement`
+
+## Parameters
+
+### reactive
+
+[`Reactive`](../type-aliases/Reactive.md)\<`boolean`, `P`, `E`\>
+
+Reactive value bound to the visibility state
+
+## Returns
+
+[`Effect`](../type-aliases/Effect.md)\<`P`, `E`\>
+
+Effect function that controls element visibility
+
+## Since
+
+0.13.1

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

@@ -0,0 +1,37 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / toSignal
+
+# Function: toSignal()
+
+> **toSignal**\<`T`\>(`value`): `T` *extends* [`Store`](../type-aliases/Store.md)\<`U`\> ? [`Store`](../type-aliases/Store.md)\<`U`\> : `T` *extends* [`State`](../type-aliases/State.md)\<`U`\> ? [`State`](../type-aliases/State.md)\<`U`\> : `T` *extends* [`Computed`](../type-aliases/Computed.md)\<`U`\> ? [`Computed`](../type-aliases/Computed.md)\<`U`\> : `T` *extends* [`Signal`](../type-aliases/Signal.md)\<`U`\> ? [`Signal`](../type-aliases/Signal.md)\<`U`\> : `T` *extends* readonly `U`[] ? [`Store`](../type-aliases/Store.md)\<`U`[]\> : `T` *extends* `Record`\<`string`, \{ \}\> ? [`Store`](../type-aliases/Store.md)\<\{ \[K in string \| number \| symbol\]: T\<T\>\[K\] \}\> : `T` *extends* [`ComputedCallback`](../type-aliases/ComputedCallback.md)\<`U`\> ? [`Computed`](../type-aliases/Computed.md)\<`U`\> : [`State`](../type-aliases/State.md)\<`T`\>
+
+Defined in: node\_modules/@zeix/cause-effect/types/src/signal.d.ts:34
+
+Convert a value to a Signal if it's not already a Signal
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`
+
+## Parameters
+
+### value
+
+`T`
+
+value to convert
+
+## Returns
+
+`T` *extends* [`Store`](../type-aliases/Store.md)\<`U`\> ? [`Store`](../type-aliases/Store.md)\<`U`\> : `T` *extends* [`State`](../type-aliases/State.md)\<`U`\> ? [`State`](../type-aliases/State.md)\<`U`\> : `T` *extends* [`Computed`](../type-aliases/Computed.md)\<`U`\> ? [`Computed`](../type-aliases/Computed.md)\<`U`\> : `T` *extends* [`Signal`](../type-aliases/Signal.md)\<`U`\> ? [`Signal`](../type-aliases/Signal.md)\<`U`\> : `T` *extends* readonly `U`[] ? [`Store`](../type-aliases/Store.md)\<`U`[]\> : `T` *extends* `Record`\<`string`, \{ \}\> ? [`Store`](../type-aliases/Store.md)\<\{ \[K in string \| number \| symbol\]: T\<T\>\[K\] \}\> : `T` *extends* [`ComputedCallback`](../type-aliases/ComputedCallback.md)\<`U`\> ? [`Computed`](../type-aliases/Computed.md)\<`U`\> : [`State`](../type-aliases/State.md)\<`T`\>
+
+- Signal instance
+
+## Since
+
+0.9.6

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

@@ -0,0 +1,48 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / toggleAttribute
+
+# Function: toggleAttribute()
+
+> **toggleAttribute**\<`P`, `E`\>(`name`, `reactive`): [`Effect`](../type-aliases/Effect.md)\<`P`, `E`\>
+
+Defined in: [src/effects/attribute.ts:66](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/effects/attribute.ts#L66)
+
+Effect for toggling a boolean attribute on an element.
+When the reactive value is true, the attribute is present; when false, it's absent.
+
+## Type Parameters
+
+### P
+
+`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md)
+
+### E
+
+`E` *extends* `Element` = `HTMLElement`
+
+## Parameters
+
+### name
+
+`string`
+
+Name of the attribute to toggle
+
+### reactive
+
+[`Reactive`](../type-aliases/Reactive.md)\<`boolean`, `P`, `E`\> = `...`
+
+Reactive value bound to the attribute presence (defaults to attribute name)
+
+## Returns
+
+[`Effect`](../type-aliases/Effect.md)\<`P`, `E`\>
+
+Effect function that toggles the attribute on the element
+
+## Since
+
+0.8.0

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

@@ -0,0 +1,48 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / toggleClass
+
+# Function: toggleClass()
+
+> **toggleClass**\<`P`, `E`\>(`token`, `reactive`): [`Effect`](../type-aliases/Effect.md)\<`P`, `E`\>
+
+Defined in: [src/effects/class.ts:15](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/effects/class.ts#L15)
+
+Effect for toggling a CSS class token on an element.
+When the reactive value is true, the class is added; when false, it's removed.
+
+## Type Parameters
+
+### P
+
+`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md)
+
+### E
+
+`E` *extends* `Element`
+
+## Parameters
+
+### token
+
+`string`
+
+CSS class token to toggle
+
+### reactive
+
+[`Reactive`](../type-aliases/Reactive.md)\<`boolean`, `P`, `E`\> = `...`
+
+Reactive value bound to the class presence (defaults to class name)
+
+## Returns
+
+[`Effect`](../type-aliases/Effect.md)\<`P`, `E`\>
+
+Effect function that toggles the class on the element
+
+## Since
+
+0.8.0

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

@@ -0,0 +1,53 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / updateElement
+
+# Function: updateElement()
+
+> **updateElement**\<`T`, `P`, `E`\>(`reactive`, `updater`): [`Effect`](../type-aliases/Effect.md)\<`P`, `E`\>
+
+Defined in: [src/effects.ts:254](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/effects.ts#L254)
+
+Core effect function for updating element properties based on reactive values.
+This function handles the lifecycle of reading, updating, and deleting element properties
+while providing proper error handling and debugging support.
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`
+
+### P
+
+`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md)
+
+### E
+
+`E` *extends* `Element`
+
+## Parameters
+
+### reactive
+
+[`Reactive`](../type-aliases/Reactive.md)\<`T`, `P`, `E`\>
+
+The reactive value that drives the element updates
+
+### updater
+
+[`ElementUpdater`](../type-aliases/ElementUpdater.md)\<`E`, `T`\>
+
+Configuration object defining how to read, update, and delete the element property
+
+## Returns
+
+[`Effect`](../type-aliases/Effect.md)\<`P`, `E`\>
+
+Effect function that manages the element property updates
+
+## Since
+
+0.9.0

package/docs-src/api/globals.md

@@ -0,0 +1,131 @@
+[**le-truc**](README.md)
+
+***
+
+# le-truc
+
+## Classes
+
+- [CircularDependencyError](classes/CircularDependencyError.md)
+- [CircularMutationError](classes/CircularMutationError.md)
+- [ContextRequestEvent](classes/ContextRequestEvent.md)
+- [DependencyTimeoutError](classes/DependencyTimeoutError.md)
+- [InvalidCallbackError](classes/InvalidCallbackError.md)
+- [InvalidComponentNameError](classes/InvalidComponentNameError.md)
+- [InvalidCustomElementError](classes/InvalidCustomElementError.md)
+- [InvalidEffectsError](classes/InvalidEffectsError.md)
+- [InvalidPropertyNameError](classes/InvalidPropertyNameError.md)
+- [InvalidReactivesError](classes/InvalidReactivesError.md)
+- [InvalidSignalValueError](classes/InvalidSignalValueError.md)
+- [MissingElementError](classes/MissingElementError.md)
+- [NullishSignalValueError](classes/NullishSignalValueError.md)
+- [StoreKeyExistsError](classes/StoreKeyExistsError.md)
+- [StoreKeyRangeError](classes/StoreKeyRangeError.md)
+- [StoreKeyReadonlyError](classes/StoreKeyReadonlyError.md)
+
+## Type Aliases
+
+- [Cleanup](type-aliases/Cleanup.md)
+- [Collection](type-aliases/Collection.md)
+- [CollectionListener](type-aliases/CollectionListener.md)
+- [Component](type-aliases/Component.md)
+- [ComponentProp](type-aliases/ComponentProp.md)
+- [ComponentProps](type-aliases/ComponentProps.md)
+- [ComponentSetup](type-aliases/ComponentSetup.md)
+- [ComponentUI](type-aliases/ComponentUI.md)
+- [Computed](type-aliases/Computed.md)
+- [ComputedCallback](type-aliases/ComputedCallback.md)
+- [Context](type-aliases/Context.md)
+- [ContextType](type-aliases/ContextType.md)
+- [DangerouslySetInnerHTMLOptions](type-aliases/DangerouslySetInnerHTMLOptions.md)
+- [DiffResult](type-aliases/DiffResult.md)
+- [Effect](type-aliases/Effect.md)
+- [EffectCallback](type-aliases/EffectCallback.md)
+- [Effects](type-aliases/Effects.md)
+- [ElementEffects](type-aliases/ElementEffects.md)
+- [ElementFromKey](type-aliases/ElementFromKey.md)
+- [ElementQueries](type-aliases/ElementQueries.md)
+- [ElementUpdater](type-aliases/ElementUpdater.md)
+- [EventHandler](type-aliases/EventHandler.md)
+- [EventType](type-aliases/EventType.md)
+- [Fallback](type-aliases/Fallback.md)
+- [Initializers](type-aliases/Initializers.md)
+- [LooseReader](type-aliases/LooseReader.md)
+- [MatchHandlers](type-aliases/MatchHandlers.md)
+- [MaybeCleanup](type-aliases/MaybeCleanup.md)
+- [MaybeSignal](type-aliases/MaybeSignal.md)
+- [Parser](type-aliases/Parser.md)
+- [ParserOrFallback](type-aliases/ParserOrFallback.md)
+- [PassedProp](type-aliases/PassedProp.md)
+- [PassedProps](type-aliases/PassedProps.md)
+- [Reactive](type-aliases/Reactive.md)
+- [Reader](type-aliases/Reader.md)
+- [ReservedWords](type-aliases/ReservedWords.md)
+- [ResolveResult](type-aliases/ResolveResult.md)
+- [SensorEvents](type-aliases/SensorEvents.md)
+- [Signal](type-aliases/Signal.md)
+- [State](type-aliases/State.md)
+- [Store](type-aliases/Store.md)
+- [UI](type-aliases/UI.md)
+- [UnknownContext](type-aliases/UnknownContext.md)
+
+## Variables
+
+- [batch](variables/batch.md)
+- [CONTEXT\_REQUEST](variables/CONTEXT_REQUEST.md)
+- [createComputed](variables/createComputed.md)
+- [createEffect](variables/createEffect.md)
+- [createState](variables/createState.md)
+- [createStore](variables/createStore.md)
+- [diff](variables/diff.md)
+- [isAbortError](variables/isAbortError.md)
+- [isAsyncFunction](variables/isAsyncFunction.md)
+- [isComputed](variables/isComputed.md)
+- [isEqual](variables/isEqual.md)
+- [isFunction](variables/isFunction.md)
+- [isMutableSignal](variables/isMutableSignal.md)
+- [isNumber](variables/isNumber.md)
+- [isRecord](variables/isRecord.md)
+- [isRecordOrArray](variables/isRecordOrArray.md)
+- [isSignal](variables/isSignal.md)
+- [isState](variables/isState.md)
+- [isStore](variables/isStore.md)
+- [isString](variables/isString.md)
+- [isSymbol](variables/isSymbol.md)
+- [toError](variables/toError.md)
+- [UNSET](variables/UNSET.md)
+- [valueString](variables/valueString.md)
+
+## Functions
+
+- [asBoolean](functions/asBoolean.md)
+- [asEnum](functions/asEnum.md)
+- [asInteger](functions/asInteger.md)
+- [asJSON](functions/asJSON.md)
+- [asNumber](functions/asNumber.md)
+- [asString](functions/asString.md)
+- [createCollection](functions/createCollection.md)
+- [createSensor](functions/createSensor.md)
+- [dangerouslySetInnerHTML](functions/dangerouslySetInnerHTML.md)
+- [defineComponent](functions/defineComponent.md)
+- [isCollection](functions/isCollection.md)
+- [isParser](functions/isParser.md)
+- [match](functions/match.md)
+- [on](functions/on.md)
+- [pass](functions/pass.md)
+- [provideContexts](functions/provideContexts.md)
+- [read](functions/read.md)
+- [requestContext](functions/requestContext.md)
+- [resolve](functions/resolve.md)
+- [runEffects](functions/runEffects.md)
+- [runElementEffects](functions/runElementEffects.md)
+- [schedule](functions/schedule.md)
+- [setAttribute](functions/setAttribute.md)
+- [setProperty](functions/setProperty.md)
+- [setStyle](functions/setStyle.md)
+- [setText](functions/setText.md)
+- [show](functions/show.md)
+- [toggleAttribute](functions/toggleAttribute.md)
+- [toggleClass](functions/toggleClass.md)
+- [toSignal](functions/toSignal.md)
+- [updateElement](functions/updateElement.md)

package/docs-src/api/type-aliases/Cleanup.md

@@ -0,0 +1,27 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / Cleanup
+
+# Type Alias: Cleanup()
+
+> **Cleanup** = () => `void`
+
+Defined in: node\_modules/@zeix/cause-effect/types/src/system.d.ts:1
+
+## Returns
+
+`void`
+
+## Name
+
+Le Truc
+
+## Version
+
+0.15.0
+
+## Author
+
+Esther Brunner

package/docs-src/api/type-aliases/Collection.md

@@ -0,0 +1,91 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / Collection
+
+# Type Alias: Collection\<E\>
+
+> **Collection**\<`E`\> = `object`
+
+Defined in: [src/signals/collection.ts:15](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/signals/collection.ts#L15)
+
+## Type Parameters
+
+### E
+
+`E` *extends* `Element`
+
+## Indexable
+
+\[`n`: `number`\]: `E`
+
+## Properties
+
+### \[isConcatSpreadable\]
+
+> `readonly` **\[isConcatSpreadable\]**: `true`
+
+Defined in: [src/signals/collection.ts:17](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/signals/collection.ts#L17)
+
+***
+
+### \[toStringTag\]
+
+> `readonly` **\[toStringTag\]**: `"Collection"`
+
+Defined in: [src/signals/collection.ts:16](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/signals/collection.ts#L16)
+
+***
+
+### length
+
+> `readonly` **length**: `number`
+
+Defined in: [src/signals/collection.ts:22](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/signals/collection.ts#L22)
+
+## Methods
+
+### \[iterator\]()
+
+> **\[iterator\]**(): `IterableIterator`\<`E`\>
+
+Defined in: [src/signals/collection.ts:18](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/signals/collection.ts#L18)
+
+#### Returns
+
+`IterableIterator`\<`E`\>
+
+***
+
+### get()
+
+> **get**(): `E`[]
+
+Defined in: [src/signals/collection.ts:20](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/signals/collection.ts#L20)
+
+#### Returns
+
+`E`[]
+
+***
+
+### on()
+
+> **on**(`type`, `listener`): [`Cleanup`](Cleanup.md)
+
+Defined in: [src/signals/collection.ts:21](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/signals/collection.ts#L21)
+
+#### Parameters
+
+##### type
+
+`"add"` | `"remove"`
+
+##### listener
+
+[`CollectionListener`](CollectionListener.md)\<`E`\>
+
+#### Returns
+
+[`Cleanup`](Cleanup.md)

package/docs-src/api/type-aliases/CollectionListener.md

@@ -0,0 +1,27 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / CollectionListener
+
+# Type Alias: CollectionListener()\<E\>
+
+> **CollectionListener**\<`E`\> = (`changes`) => `void`
+
+Defined in: [src/signals/collection.ts:13](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/signals/collection.ts#L13)
+
+## Type Parameters
+
+### E
+
+`E` *extends* `Element`
+
+## Parameters
+
+### changes
+
+readonly `E`[]
+
+## Returns
+
+`void`

package/docs-src/api/type-aliases/Component.md

@@ -0,0 +1,17 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / Component
+
+# Type Alias: Component\<P\>
+
+> **Component**\<`P`\> = `HTMLElement` & `P`
+
+Defined in: [src/component.ts:39](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/component.ts#L39)
+
+## Type Parameters
+
+### P
+
+`P` *extends* [`ComponentProps`](ComponentProps.md)

package/docs-src/api/type-aliases/ComponentProp.md

@@ -0,0 +1,11 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / ComponentProp
+
+# Type Alias: ComponentProp
+
+> **ComponentProp** = `Exclude`\<`string`, keyof `HTMLElement` \| [`ReservedWords`](ReservedWords.md)\>
+
+Defined in: [src/component.ts:36](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/component.ts#L36)