StateAdapt

Appearance

Function: adapt() ​

adapt<State, S, R, R2, ReturnedSources>(initialState, second): ReactStore<State, S, object extends R ? R2 : R>

Defined in: lib/adapt.function.ts:29

See StateAdapt.adapt for the complete API.

This wrapper additionally lets you call the store as a function for its current state, or call a selector property for its current result.

ts
import { stringAdapter } from '@state-adapt/core/adapters';
import { adapt } from '@state-adapt/react';

const name = adapt('John', stringAdapter);

console.log(name()); // 'John'
console.log(name.uppercase()); // 'JOHN'

See derive for composing these reads.

Type Parameters ​

State ​

State

S ​

S extends Selectors<State>

R ​

R extends ReactionsWithSelectors<State, S>

R2 ​

R2 extends ReactionsWithSelectors<State, S>

ReturnedSources ​

ReturnedSources = unknown

Parameters ​

initialState ​

InitialState<State>

second ​

R & object & NotAdaptOptions | AdaptOptions<State, S, R2, ReturnedSources>

Returns ​

ReactStore<State, S, object extends R ? R2 : R>