npm

@ithinkdt/storage
TypeScript icon, indicating that this package has built-in type declarations

1.2.3 • Public • Published

@ithinkdt/storage

Web存储localStorage、sessionStorage、cookie的TypeScript封装,提供通用的API方法(同原有的js方法名称均一致),同时支持泛型方法。

安装

Using npm:

$ npm install @ithinkdt/storage

Using yarn:

$ yarn add @ithinkdt/storage

示例

LocalStorage测试

import { LocalStorage } from '@ithinkdt/storage';

// LocalStorage测试
const key1 = 'local_number';
const value1 = 666888;
LocalStorage.setItem<number>(key1, value1); // 返回:true/false;
LocalStorage.getItem<number>(key1); // 返回:666888/null;
LocalStorage.removeItem(key1); // 返回:true/false;

const key2 = 'local_string';
const value2 = 'hello world';
LocalStorage.setItem<string>(key2, value2); // 返回:true/false;
LocalStorage.getItem<string>(key2); // 返回:'hello world'/null;
LocalStorage.removeItem(key2); // 返回:true/false;

const key3 = 'local_boolean';
const value3 = true;
LocalStorage.setItem<boolean>(key3, value3); // 返回:true/false;
LocalStorage.getItem<boolean>(key3); // 返回:true/null;
LocalStorage.removeItem(key3); // 返回:true/false;

SessionStorage测试

import { SessionStorage } from '@ithinkdt/storage';

// SessionStorage测试
const key1 = 'session_number';
const value1 = 666888;
SessionStorage.setItem<number>(key1, value1); // 返回:true/false;
SessionStorage.getItem<number>(key1); // 返回:666888/null;
SessionStorage.removeItem(key1); // 返回:true/false

const key2 = 'session_string';
const value2 = 'bala bala xiaomoxian';
SessionStorage.setItem<string>(key2, value2); // 返回:true/false;
SessionStorage.getItem<string>(key2); // 返回:'bala bala xiaomoxian'/null;
SessionStorage.removeItem(key2); // 返回:true/false;

Cookie测试

import {Cookie, ICookieOption} from '@ithinkdt/cookie';

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

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

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

API

LocalStorage.setItem(key: string, value: T): boolean
LocalStorage.getItem(key: string): T | null
LocalStorage.removeItem(key: string): boolean
LocalStorage.clear(): void
SessionStorage.setItem(key: string, value: T): boolean
SessionStorage.getItem(key: string): T | null
SessionStorage.removeItem(key: string): boolean
SessionStorage.clear(): void
Cookie.setItem(key: string, value: T [, expires: number] [, path: string]): boolean
Cookie.setItems(options: Array): boolean
Cookie.getItem(key: string): T | null
Cookie.getAllKeys(): Array
Cookie.removeItem(key: string): boolean
Cookie.clear(): void

Package Sidebar

Install

npm i @ithinkdt/storage

Weekly Downloads

12

Version

1.2.3

License

ISC

Unpacked Size

14.3 kB

Total Files

11

Last publish

Collaborators

  • yuntaoc
  • liuzw2579
  • ithinkdt-admin