Skip to content

@bynary.composables.storage.Interface.IUseStorageOptions

github-actions[bot] edited this page Jul 11, 2024 · 3 revisions

@bynary/composables / @bynary/composables/storage / IUseStorageOptions

Interface: IUseStorageOptions<T>

Options for useStorage

Extends

Type Parameters

T extends string

Properties

initialValue?

optional initialValue: null | T

The initial value to use for the storage.

Default Value

- The current value from the storage

Defined in

storage/src/use-storage.composable.ts:13


skipInitialRead?

optional skipInitialRead: boolean

Whether to skip reading the current value from the storage initially. If set to true, the value will be read from the storage only when it changes.

Default Value

false

Inherited from

IBindStorageOptions.skipInitialRead

Defined in

storage/src/read-from-storage.composable.ts:15


storage?

optional storage: Storage

The storage to use.

Default Value

localStorage

Inherited from

IBindStorageOptions.storage

Defined in

storage/src/base-storage.ts:11

Clone this wiki locally