Store Docs
API Reference
Store API Reference
- Store
- ReadonlyStore
- Atom
- AtomOptions
- BaseAtom
- InternalBaseAtom
- InternalReadonlyAtom
- InteropSubscribable
- Readable
- ReadonlyAtom
- StoreActionsApi
- Subscribable
- Subscription
- AnyAtom
- Observer
- Selection
- StoreAction
- StoreActionMap
- StoreActionsFactory
- batch
- createAsyncAtom
- createAtom
- createStore
- flush
- shallow
- toObserver
- createStoreContext
- useCreateAtom
- useCreateStore
- useSelector
- useSetValue
- useAtom
- useStoreActions
- _useStore (experimental)
- useStore (deprecated)
- UseSelectorOptions
AI/LLM: This documentation page is available in plain markdown format at/store/latest/docs/reference/classes/ReadonlyStore.md
Store API Reference
ReadonlyStore
Defined in: store.ts:59
Type Parameters#
T#
T
Implements#
- Omit<Store<T>, "setState" | "actions">
Constructors#
Constructor#
ts
new ReadonlyStore<T>(getValue): ReadonlyStore<T>;Defined in: store.ts:64
Parameters#
getValue#
(prev?) => T
Returns#
ReadonlyStore<T>
Constructor#
ts
new ReadonlyStore<T>(initialValue): ReadonlyStore<T>;Defined in: store.ts:65
Parameters#
initialValue#
T
Returns#
ReadonlyStore<T>
Accessors#
state#
Get Signature#
ts
get state(): T;Defined in: store.ts:73
Returns#
T
Implementation of#
ts
Omit.stateMethods#
get()#
ts
get(): T;Defined in: store.ts:76
Returns#
T
Implementation of#
ts
Omit.getsubscribe()#
ts
subscribe(observerOrFn): Subscription;Defined in: store.ts:79
Parameters#
observerOrFn#
Observer<T> | ((value) => void)
Returns#
Implementation of#
ts
Omit.subscribe