browser-storage-adapter/dist/type.d.ts

Browser storage adapter to crud 1-n different stores simultaneously

import { CookieSerializeOptions } from 'cookie-es';
export type Options = {
    /**
     * Specify a key prefix.
     * e.g.
     *  namespace: auth
     *  key: token
     *  keyWithNamespace: auth_token
     */
    namespace?: string;
    /**
     * Enable or disable some available drivers.
     */
    driver: {
        localStorage?: boolean;
        sessionStorage?: boolean;
        cookie?: boolean | CookieSerializeOptions;
    };
    /**
     * Check if the application is server rendered.
     */
    isServer: () => boolean;
    /**
     * Set cookie.
     *
     * @param key
     * @param value
     */
    setCookie?: (key: string, value: unknown) => void;
    /**
     * Get cookie.
     *
     * @param key
     */
    getCookie?: (key: string) => unknown;
    /**
     * Append serialized cookie.
     *
     * @param value
     */
    setServerCookie?: (value: string) => void;
    /**
     * Ger serialized cookie(s).
     */
    getServerCookies?: () => string;
};
export type OptionsInput = Partial<Options>;
/**
 * This is an alias for the OptionsInput type.
 * Will be removed in v2.0.0+
 *
 * @deprecated
 */
export type AdapterOptions = OptionsInput;