Class SharedState<T>

constructor

• new SharedState<T>(
      defaultValue: T,
      options?: SharedStateOptions<T>,
  ): SharedState<T>

  Type Parameters

  • T

  Parameters

  • defaultValue: T
  • Optionaloptions: SharedStateOptions<T>

  Returns SharedState<T>

initDone

initStarted

ReadonlyreadyPromise

ReadonlysetValueBounded

delete

• delete(): void

  Remove the value of the shared state. Actually this just sets the value back to the given default value.

  Returns void

getFromStore

• getFromStore(): Promise<T | undefined>

  Get a value directly from the store. Returns undefined if there is no backing store.

  Returns Promise<T | undefined>

getSnapshot

• getSnapshot(): T

  Get the value of the shared state. getSnapshot function — must return same ref if value unchanged. Note that this would return the default value if data init from store is not completed yet.

  Returns T

hasStore

• hasStore(): boolean

  Returns true if there is a backing store.

  Returns boolean

initDefaultValueOnce

• initDefaultValueOnce(): Promise<void>

  Initial default handling.

  Returns Promise<void>

setInStore

• setInStore(value: T): Promise<void>

  Set a value directly into the store. Does nothing if there is no backing store.

  Warning: If you want to set the value properly, you should use setValue() instead which also updates the in-memory copy.

  Parameters

  • value: T

  Returns Promise<void>

setValue

• setValue(next: SetStateAction<T>): void

  Set the value of the shared state.

  Parameters

  • next: SetStateAction<T>

  Returns void

subscribe

• subscribe(subscriber: () => void): () => void

  subscribe function required by useSyncExternalStore.

  Parameters

  • subscriber: () => void

  Returns () => void