Class: Signal<T>
Defined in: @preact/signals-core:
The base class for plain and computed signals.
Extends
ReactElement
Type Parameters
| Type Parameter | Default type |
|---|---|
T | any |
Accessors
value
Get Signature
ts
get value(): T;Defined in: @preact/signals-core:
Returns
T
Set Signature
ts
set value(value: T): void;Defined in: @preact/signals-core:
Parameters
| Parameter | Type |
|---|---|
value | T |
Returns
void
Constructors
Constructor
ts
new Signal<T>(value?: T, options?: SignalOptions<T>): Signal<T>;Defined in: @preact/signals-core:
Parameters
| Parameter | Type |
|---|---|
value? | T |
options? | SignalOptions<T> |
Returns
Signal<T>
Methods
peek()
ts
peek(): T;Defined in: @preact/signals-core:
Returns
T
subscribe()
ts
subscribe(fn: (value: T) => void): () => void;Defined in: @preact/signals-core:
Parameters
| Parameter | Type |
|---|---|
fn | (value: T) => void |
Returns
() => void
toJSON()
ts
toJSON(): T;Defined in: @preact/signals-core:
Returns
T
toString()
ts
toString(): string;Defined in: @preact/signals-core:
Returns
string
valueOf()
ts
valueOf(): T;Defined in: @preact/signals-core:
Returns
T
Properties
brand
ts
brand: typeof BRAND_SYMBOL;Defined in: @preact/signals-core:
key
ts
key: string | null;Defined in: @types/react:
name?
ts
optional name?: string;Defined in: @preact/signals-core:
props
ts
props: unknown;Defined in: @types/react:
type
ts
type: string | JSXElementConstructor<any>;Defined in: @types/react: