Class LocalStorageClient<Shapes>

constructor

• new LocalStorageClient<
      const Shapes extends Readonly<BaseLocalStorageClientShapes>,
  >(
      shapes: Readonly<Shapes>,
      options?: Readonly<PartialWithUndefined<LocalStorageClientOptions>>,
  ): LocalStorageClient<Shapes>

  Type Parameters

  • const Shapes extends Readonly<BaseLocalStorageClientShapes>

  Parameters

  • shapes: Readonly<Shapes>
  • options: Readonly<PartialWithUndefined<LocalStorageClientOptions>> = {}

  Returns LocalStorageClient<Shapes>

Readonlydelete

Readonlyget

Readonlylisten

Readonlyset

ReadonlystoreName

AllValuesType

• get AllValuesType(): LocalStorageClientAllValues<Shapes>

  The type for all values. Cannot be accessed as a value at runtime, only meant to be used as a type.

  Returns LocalStorageClientAllValues<Shapes>

ValueType

• get ValueType(): RequiredAndNotNull<LocalStorageClientAllValues<Shapes>>

  The type for each value. Cannot be accessed as a value at runtime, only meant to be used as a type.

  Returns RequiredAndNotNull<LocalStorageClientAllValues<Shapes>>

clear

• clear(): void

  Clear all values.

  Returns void

destroy

• destroy(): void

  Cleanup the client and free-up resources.

  Returns void

getAllValues

• getAllValues(
      __namedParameters?: LocalStorageClientGetOptions,
  ): LocalStorageClientAllValues<Shapes>

  Get all current values. Any values that have not been set or that are invalid will not be present.

  Parameters

  • __namedParameters: LocalStorageClientGetOptions = {}

  Returns LocalStorageClientAllValues<Shapes>

  Throws

  If throwErrorOnFailure is set and JSON cannot be parsed or a value does not match its shape.

listenToAllValues

• listenToAllValues(
      callback: (
          allValues: LocalStorageClientAllValues<Shapes>,
      ) => MaybePromise<void>,
  ): RemoveListenerCallback

  Listen to .set calls.

  Parameters

  • callback: (allValues: LocalStorageClientAllValues<Shapes>) => MaybePromise<void>

  Returns RemoveListenerCallback

  A callback to remove the attached listener.