dowding-utils v0.0.3

dowding-utils

说明

常用前端工具 cookie、sessionStorage、localStorage、JSON、url处理

开发本仓库

需掌握基础TypeScript

git clone http://172.16.0.108/dowding/dowding-front-utils.git
npm config set registry dowding-npm.istarshine.net.cn
npm login
npm publish

使用

cookie

import { ProCookies } from 'dowding-utils'

set(name, value,options): boolean

const user = { info: { name: 'user1' }, work: { base: 'beijing' } }
ProCookies.set('user', user) // 设置成功返回true，否则返回false

可选参数options
{
  expires?: [number, 'days' | 'hours' | 'minutes' | 'seconds'] | string | number; // 过期时间
  domain?: string; // 生效域名
  path?: string; // 生效路径
}

get(name,path): any

// 假设已设置cookie为 user = { info: { name: 'user1' }, work: { base: 'beijing' } }

ProCookies.get(user) // return { info: { name: 'user1' }, work: { base: 'beijing' } }
ProCookies.get(user, 'info') // return { name: 'user1' }
ProCookies.get(user, 'info.name') // return 'user1'

getAll

ProCookies.getAll() // 获取所有cookie

remove(name,options)

ProCookies.remove('user') // 删除user

可选参数options
{
  domain?: string; // 生效域名
  path?: string; // 生效路径
}

clear(options)

ProCookies.clear() // 删除所有cookie

ProCookies.clear({ // 删除test.com域名下所有cookie
	domain: 'test.com'
})

可选参数options
{
  domain?: string; // 生效域名
  path?: string; // 生效路径
}

sessionStorage

import { ProSessionStorage } from 'dowding-utils'

set(name, value,stringify): boolean

const user = { info: { name: 'user1' }, work: { base: 'beijing' } }
const userJson = JSON.stringify(user)

ProSessionStorage.set('user', user) // 设置user，默认使用stringify值，无需手动stringify
ProSessionStorage.set('user', userJson, false) // 设置user，手动stringify

get(name, path,parse)

// 假设已设置sessionStorage为 user = { info: { name: 'user1' }, work: { base: 'beijing' } }

ProSessionStorage.get('user') //return { info: { name: 'user1' }, work: { base: 'beijing' } }
ProSessionStorage.get('user', 'info') // return { name: 'user1' }
ProSessionStorage.get('user', '', false) // 返回字符串 '{"info":{"name":"user1"},"work":{"base":"beijing"}}'

// 如果设置了path，即便不使用parse，依然会返回parse后的值
ProSessionStorage.get('user', 'info', false) // return { name: 'user1' }

remove

ProSessionStorage.remove('user') // 删除指定名称的记录

clear

ProSessionStorage.clear() // 清空整个sessionStorage

localStorage

import { ProLocalStorage } from 'dowding-utils'

其他方法同 ProSessionStorage

JSON

url