@angular-architects/ngrx-toolkit 19.0.2 → 19.2.0

package/lib/with-storage-sync.d.ts

@@ -1,52 +0,0 @@
-import { SignalStoreFeature, SignalStoreFeatureResult, EmptyFeatureResult } from '@ngrx/signals';
-type WithStorageSyncFeatureResult = EmptyFeatureResult & {
-    methods: {
-        clearStorage(): void;
-        readFromStorage(): void;
-        writeToStorage(): void;
-    };
-};
-export type SyncConfig<State> = {
-    /**
-     * The key which is used to access the storage.
-     */
-    key: string;
-    /**
-     * Flag indicating if the store should read from storage on init and write to storage on every state change.
-     *
-     * `true` by default
-     */
-    autoSync?: boolean;
-    /**
-     * Function to select that portion of the state which should be stored.
-     *
-     * Returns the whole state object by default
-     */
-    select?: (state: State) => Partial<State>;
-    /**
-     * Function used to parse the state coming from storage.
-     *
-     * `JSON.parse()` by default
-     */
-    parse?: (stateString: string) => State;
-    /**
-     * Function used to tranform the state into a string representation.
-     *
-     * `JSON.stringify()` by default
-     */
-    stringify?: (state: State) => string;
-    /**
-     * Factory function used to select the storage.
-     *
-     * `localstorage` by default
-     */
-    storage?: () => Storage;
-};
-/**
- * Enables store synchronization with storage.
- *
- * Only works on browser platform.
- */
-export declare function withStorageSync<Input extends SignalStoreFeatureResult>(key: string): SignalStoreFeature<Input, WithStorageSyncFeatureResult>;
-export declare function withStorageSync<Input extends SignalStoreFeatureResult>(config: SyncConfig<Input['state']>): SignalStoreFeature<Input, WithStorageSyncFeatureResult>;
-export {};