Skip to content

Latest commit

 

History

History
115 lines (85 loc) · 3.88 KB

README-zh-CN.md

File metadata and controls

115 lines (85 loc) · 3.88 KB
Raw

browser-storage

English | 中文简体

Version codecov Build Status Downloads

按自定义的优先级使用 Cookie、LocalStorage、SessionStorage 存储

自动检测浏览器是否支持，若不支持使用下一优先级项进行存储

特性

  • Cookie storage options can be modified
  • Compact size 8.1KB (2.3KB gzipped)

安装

You can install it via yarn or NPM.

$ yarn add @gaoming13/browser-storage
$ npm i @gaoming13/browser-storage

CDN

jsdelivr

<script src="https://cdn.jsdelivr.net/npm/@gaoming13/browser-storage@1.0.1"></script>

unpkg

<script src="https://unpkg.com/@gaoming13/browser-storage@1.0.1"></script>

例子

import browserStorage from '@gaoming13/browser-storage';

// 定义存储的优先级，按照优先级找浏览器支持的的存储
// `c` 指代 Cookie, `s` 指代 SessionStorage, `l` 指代 LocalStorage
browserStorage.setPriority('csl');

// 存储某个值
browserStorage.setItem('item1', 'hello world');

// 获取某个值
browserStorage.getItem('item1'); // It will return `hello world`

// 删除某个值
browserStorage.removeItem('item1');
// 设置优先级，限制只使用 Cookie 存储
browserStorage.setPriority('c');

// 设置存储键名的前缀（例如存储了 `item2`，那么实际存储的键名就是 `h5-item2`）
browserStorage.setPreKey('h5-');

// 设置 Cookie 存储选项
// 设置 Expires/Max-Age = Session
browserStorage.setCookieOptions({ path: '/abc', domain: 'local.com' });
// 更多选项信息请查阅 [https://github.com/jshttp/cookie#options-1](https://github.com/jshttp/cookie#options-1)
browserStorage.setCookieOptions({ path: '/abc', maxAge: 86400, domain: 'local.com' });

// 存储某个值
browserStorage.setItem('item2', 'xxxx');

API

  • getItem(key) 获取某个值
  • setItem(key, value) 存储某个值
  • removeItem(key) 删除某个值
  • setPriority(priority) 设置存储方式优先级
    • @example obj.setPriority('c')
    • @example obj.setPriority('cl')
    • @example obj.setPriority('cs')
    • @example obj.setPriority('cls')
  • setPreKey(key) 设置键名前缀
    • @example obj.setPreKey('h5-')
  • cookieStoreSetPreKey(key) 设置 Cookie 键名前缀
    • @example obj.cookieStoreSetPreKey('h5-')
  • localStoreSetPreKey(key) 设置 LocalStorage 键名前缀
  • seesionStoreSetPreKey(key) 设置 SessionStorage 键名前缀
  • cookieStoreIsSupport() 浏览器是否支持 Cookie
  • localStoreIsSupport() 浏览器是否支持 LocalStorage
  • seesionStoreIsSupport() 浏览器是否支持 SessionStorage
  • cookieSetOptions 设置 Cookie 存储选项
    • @example setCookieOptions({ path: '/abc', maxAge: 86400, domain: 'local.com' })

Changelog

Details changes for each release are documented in the release notes.

Contribution

If you find a bug or want to contribute to the code or documentation, you can help by submitting an issue or a pull request.

License

MIT