classy-solid/dist/signals/createSignalObject.d.ts

Solid.js reactivity patterns for classes, and class components.

import type { SignalOptions } from 'solid-js/types/reactive/signal';
import type { Signal } from 'solid-js/types/reactive/signal';
/**
 * A signal represented as an object with .get and .set methods.
 */
export interface SignalObject<T> {
    /** Gets the signal value. */
    get: Signal<T>[0];
    /** Sets the signal value. */
    set: (v: T | ((prev: T) => T)) => T;
}
/**
 * Create a Solid signal wrapped in the form of an object with `.get` and `.set`
 * methods for alternative usage patterns.
 *
 * ```js
 * let count = createSignalObject(0) // count starts at 0
 * count.set(1) // set the value of count to 1
 * count.set(count.get() + 1) // add 1
 * let currentValue = count.get() // read the current value
 * ```
 *
 * This is more convenient for class properties than using `createSignal`. With `createSignal`:
 *
 * ```js
 * class Foo {
 *   count = createSignal(0)
 *
 *   increment() {
 *     // difficult to read
 *     this.count[1](this.count[0]() + 1)
 *
 *     // also:
 *     this.count[1](c => c + 1)
 *   }
 * }
 * ```
 *
 * With `createSignalObject`:
 *
 * ```js
 * class Foo {
 *   count = createSignalObject(0)
 *
 *   increment() {
 *     // Easier to read
 *     this.count.set(this.count.get() + 1)
 *
 *     // also:
 *     this.count.set(c => c + 1)
 *   }
 * }
 * ```
 *
 * See also `createSignalFunction` for another pattern.
 */
export declare function createSignalObject<T>(): SignalObject<T | undefined>;
export declare function createSignalObject<T>(value: T, options?: SignalOptions<T>): SignalObject<T>;
//# sourceMappingURL=createSignalObject.d.ts.map