restash/dist/esm/utils.d.ts

Simple React context store, set it or get it.

import { Path } from './types';
/**
 * Validates iniital state type.
 *
 * @param initialState the initialState to be validated.
 */
export declare function validateState<S = any>(initialState: S): void;
/**
 * Gets the initialiState by passed in value or value from window if using SSR.
 *
 * @param initialState the initial state passed in manually.
 * @param stateKey the key on the window to use if avail (ssr ONLY).
 */
export declare function getInitialState<S = any>(initialState: S, stateKey: string): any;
/**
 * Internal function to thunkify middleware.
 */
export declare function thunkify(): (store: any) => (next: any) => (payload: any) => any;
/**
 * Middleware to unwrap payload to match raw dispatch signature.
 */
export declare function unwrap(): (store: any) => (next: any) => (payload: any) => any;
/**
 * Checks if is string.
 *
 * @param value the value to inspect.
 */
export declare function isString(value: unknown): boolean;
/**
 * Checks if is of type Symbol.
 *
 * @param value the value to inspect.
 */
export declare function isSymbol(value: unknown): boolean;
/**
 * Checks if is undefined.
 *
 * @param value the value to inspect.
 */
export declare function isUndefined(value: unknown): boolean;
/**
 * Checks if is null or undefined.
 *
 * @param value the value to inspect.
 */
export declare function isNullOrUndefined(value: unknown): boolean;
/**
 * Checks if is function
 *
 * @param value the value to inspect.
 */
export declare function isFunction(value: unknown): boolean;
/**
 * Checks if is an object.
 *
 * @param value the value to inspect.
 */
export declare function isObject(value: unknown): boolean;
/**
 * Checks if is a plain object.
 *
 * @param value the value to inspect.
 */
export declare function isPlainObject(value: unknown): boolean;
/**
 * Loosely checks if value is empty.
 *
 * @param value the value to inspect.
 */
export declare function isEmpty(value: unknown): boolean;
/**
 * Tries to stringify JSON.
 *
 * @param value the value to stringify.
 */
export declare function tryStringifyJSON(value: Record<string, any>): string | false;
/**
 * Tries to parse JSON.
 *
 * @param value the value to parse.
 */
export declare function tryParseJSON(value: string): any;
/**
 * Merges store initial state with the persistent state.
 *
 * @param initialState the state the store was initialized with.
 * @param persistentState the persistent state from localStorage.
 */
export declare function mergeStore<S extends Record<string, any>>(initialState: S, persistentState: Record<string, any>): S;
/**
 * Iterates store value and filters out provided keys.
 *
 * @param value the current store value.
 * @param strategy whether to include the filters or exclude them.
 * @param filters the values to be filtered.
 */
export declare function filterKeys<S extends Record<string, any>>(value: S, strategy: 'include' | 'exclude', filters: (Path<S> | string)[]): any;
/**
 * Persists state to storage.
 *
 * @param key the key used to set storage.
 * @param value the value to be set.
 * @param filters an array of keys to filter from persisted object.
 */
export declare function setStorage<S extends Record<string, any>>(key: string, value: S, filters?: Path<S>[]): void;
/**
 * Gets state from storage.
 *
 * @param key the storage key to retrieve.
 * @param filters array of keys to filter.
 */
export declare function getStorage<S extends Record<string, any>>(key: string, filters?: Path<S>[]): S | Partial<S>;
/**
 * Clears entire storage for store or clears by defined filter key.
 *
 * @param key the storage key for the store.
 * @param filters key filters to set.
 */
export declare function clearStorage<S extends Record<string, any>>(key: string, filters?: (Path<S> | string)[]): boolean;
/**
 * Returns true if window is defined.
 */
export declare function isWindow(): boolean;