|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354 |
- import * as universal_cookie from 'universal-cookie';
- import universal_cookie__default from 'universal-cookie';
- import { IncomingMessage } from 'http';
-
- /**
- * Creates a new {@link useCookies} function
- * @param {Object} req - incoming http request (for SSR)
- * @see https://github.com/reactivestack/cookies/tree/master/packages/universal-cookie universal-cookie
- * @description Creates universal-cookie instance using request (default is window.document.cookie) and returns {@link useCookies} function with provided universal-cookie instance
- */
- declare function createCookies(req?: IncomingMessage): (dependencies?: string[] | null, { doNotParse, autoUpdateDependencies }?: {
- doNotParse?: boolean | undefined;
- autoUpdateDependencies?: boolean | undefined;
- }) => {
- /**
- * Reactive get cookie by name. If **autoUpdateDependencies = true** then it will update watching dependencies
- */
- get: <T = any>(name: string, options?: universal_cookie.CookieGetOptions | undefined) => T;
- /**
- * Reactive get all cookies
- */
- getAll: <T_1 = any>(options?: universal_cookie.CookieGetOptions | undefined) => T_1;
- set: (name: string, value: any, options?: universal_cookie.CookieSetOptions | undefined) => void;
- remove: (name: string, options?: universal_cookie.CookieSetOptions | undefined) => void;
- addChangeListener: (callback: universal_cookie.CookieChangeListener) => void;
- removeChangeListener: (callback: universal_cookie.CookieChangeListener) => void;
- };
- /**
- * Reactive methods to work with cookies (use {@link createCookies} method instead if you are using SSR)
- * @param {string[]|null|undefined} dependencies - array of watching cookie's names. Pass empty array if don't want to watch cookies changes.
- * @param {Object} options
- * @param {boolean} options.doNotParse - don't try parse value as JSON
- * @param {boolean} options.autoUpdateDependencies - automatically update watching dependencies
- * @param {Object} cookies - universal-cookie instance
- */
- declare function useCookies(dependencies?: string[] | null, { doNotParse, autoUpdateDependencies }?: {
- doNotParse?: boolean | undefined;
- autoUpdateDependencies?: boolean | undefined;
- }, cookies?: universal_cookie__default): {
- /**
- * Reactive get cookie by name. If **autoUpdateDependencies = true** then it will update watching dependencies
- */
- get: <T = any>(name: string, options?: universal_cookie.CookieGetOptions | undefined) => T;
- /**
- * Reactive get all cookies
- */
- getAll: <T_1 = any>(options?: universal_cookie.CookieGetOptions | undefined) => T_1;
- set: (name: string, value: any, options?: universal_cookie.CookieSetOptions | undefined) => void;
- remove: (name: string, options?: universal_cookie.CookieSetOptions | undefined) => void;
- addChangeListener: (callback: universal_cookie.CookieChangeListener) => void;
- removeChangeListener: (callback: universal_cookie.CookieChangeListener) => void;
- };
-
- export { createCookies, useCookies };
|