Skip to main content

Function: withStorageSync()

Call Signature

withStorageSync<Input>(key): SignalStoreFeature<Input, WithStorageSyncFeatureResult>

Defined in: libs/ngrx-toolkit/src/lib/storage-sync/with-storage-sync.ts:66

Enables store synchronization with storage.

Only works on browser platform.

Type Parameters

Input extends SignalStoreFeatureResult

Parameters

key

string

Returns

SignalStoreFeature<Input, WithStorageSyncFeatureResult>

Call Signature

withStorageSync<Input>(key, StorageServiceClass): SignalStoreFeature<Input, WithIndexeddbSyncFeatureResult>

Defined in: libs/ngrx-toolkit/src/lib/storage-sync/with-storage-sync.ts:71

Enables store synchronization with storage.

Only works on browser platform.

Type Parameters

Input extends SignalStoreFeatureResult

Parameters

key

string

StorageServiceClass

Type<IndexeddbService>

Returns

SignalStoreFeature<Input, WithIndexeddbSyncFeatureResult>

Call Signature

withStorageSync<Input>(key, StorageServiceClass): SignalStoreFeature<Input, WithStorageSyncFeatureResult>

Defined in: libs/ngrx-toolkit/src/lib/storage-sync/with-storage-sync.ts:77

Enables store synchronization with storage.

Only works on browser platform.

Type Parameters

Input extends SignalStoreFeatureResult

Parameters

key

string

StorageServiceClass

Type<StorageService>

Returns

SignalStoreFeature<Input, WithStorageSyncFeatureResult>

Call Signature

withStorageSync<Input>(config): SignalStoreFeature<Input, WithStorageSyncFeatureResult>

Defined in: libs/ngrx-toolkit/src/lib/storage-sync/with-storage-sync.ts:83

Enables store synchronization with storage.

Only works on browser platform.

Type Parameters

Input extends SignalStoreFeatureResult

Parameters

config

SyncConfig<Input["state"]>

Returns

SignalStoreFeature<Input, WithStorageSyncFeatureResult>

Call Signature

withStorageSync<Input>(config, StorageServiceClass): SignalStoreFeature<Input, WithIndexeddbSyncFeatureResult>

Defined in: libs/ngrx-toolkit/src/lib/storage-sync/with-storage-sync.ts:88

Enables store synchronization with storage.

Only works on browser platform.

Type Parameters

Input extends SignalStoreFeatureResult

Parameters

config

SyncConfig<Input["state"]>

StorageServiceClass

Type<IndexeddbService>

Returns

SignalStoreFeature<Input, WithIndexeddbSyncFeatureResult>

Call Signature

withStorageSync<Input>(config, StorageServiceClass): SignalStoreFeature<Input, WithStorageSyncFeatureResult>

Defined in: libs/ngrx-toolkit/src/lib/storage-sync/with-storage-sync.ts:94

Enables store synchronization with storage.

Only works on browser platform.

Type Parameters

Input extends SignalStoreFeatureResult

Parameters

config

SyncConfig<Input["state"]>

StorageServiceClass

Type<StorageService>

Returns

SignalStoreFeature<Input, WithStorageSyncFeatureResult>