@ni-web-infra/common-utils/types/lib/cookie.d.ts

NI util function library

import { CookieAttributes } from "js-cookie";
/**
 * 读取cookie值
 * @function getCookie
 *
 * @param {string} name cookie名称
 * @returns {string | undefined} cookie值
 *
 * @example
 * const cookie = getCookie('user');
 * console.log('cookie值', cookie);
 */
export declare const getCookie: (name: string) => string | undefined;
/**
 * 读取所有cookie
 * @function getAllCookies
 *
 * @returns {object} cookie信息，例：{userName: 'admin'}
 *
 * @example
 * const cookie = getAllCookies();
 * console.log('所有cookie信息', cookie);
 */
export declare const getAllCookies: () => {
    [key: string]: string;
};
/**
 * 设置cookie值
 * @function setCookie
 *
 * @param {string} name cookie名称
 * @param {string} value cookie值
 * @param {CookieAttributes | undefined} options cookie属性
 *
 * @returns {string | undefined}
 *
 * @example
 * setCookie('userName', 'admin');
 */
export declare const setCookie: (name: string, value: string, options?: CookieAttributes | undefined) => string | undefined;
/**
 * 删除cookie
 * @function removeCookie
 *
 * @param {string} name cookie名称
 * @param {CookieAttributes} options cookie属性
 *
 * @example
 * removeCookie('userName');
 */
export declare const removeCookie: (name: string, options?: CookieAttributes) => void;