tsx-cookie v1.0.0

tsx-cookie

Cookie的TypeScript封装，提供通用的API方法，同时支持泛型方法。

Installing

Using npm:

$ npm install tsx-cookie

Example

import Cookie, {ICookieOption} from 'tsx-cookie';

const name1 = 'cookie_number';
const value1 = 666888;
const expires1 = 3600 * 1000 * 2;// 过期时间
Cookie.setItem<number>(name1, value1, expires1);// return true/false;
Cookie.getItem<number>(name1);// return 666888/null;
Cookie.removeItem(name1);// return true/false;

const name2 = 'cookie_string';
const value2 = 'hello world';
const expires2 = 3600 * 1000 * 2;
Cookie.setItem<string>(name2, value2, expires2);// return true/false;
Cookie.getItem<string>(name2);// return 'hello world'/null;
Cookie.removeItem(name2);// return true/false;

Cookie.getAllKeys();// return ['cookie_number', 'cookie_string']

API

/**
 * cookie选项接口
 */
export interface ICookieOption {
  // 名称
  name: string;

  // 数值
  value: any;

  // 过期时间，单位：毫秒
  expires?: number;

  // 路径
  path?: string;
}

Cookie.setItem(name: string, value: T , expires: number): boolean

Cookie.setItems(options: Array): boolean

Cookie.getItem(name: string): T | null

Cookie.getAllKeys(): Array

Cookie.removeItem(name: string, path: string): boolean

Cookie.clear(, path: string): void