vue-cookies-ts
A simple tool for handling browser cookies
Installation
npm install cookies-ts --save
Api
syntax format: cookies.[method]
config
Set global config
void //example cookies.config // default: expireTimes = 1d , path=/
set
Set a cookie
Cookies //example cookies.setkeyName: string,
get
Get a cookie
string | null | object //example cookies.getkeyName: string
remove
Remove a cookie
Cookies | boolean //example cookies.removekeyName: string,
isKey
If exist a cookie name
boolean //example cookies.isKeykeyName: string
keys
Get All cookie name
string //example cookies.keys
Example Usage
Set global config
// 30 day after, expirecookies cookies // 30 day after, expire, '' current path , browser defaultcookies
Support json object
var user = id:1 name:'Journal' session:'25j_7Sl6xDq2Kc3ym0fmrSSk2xV2XkUkX' cookies // print user nameconsole
Set expire times
Suppose the current time is : Sat, 11 Mar 2017 12:25:57 GMT
Following equivalence: 1 day after, expire
Support chaining sets together
// default expire time: 1 dayCookies// number + d , ignore case// Base of second// input a Date, + 1day// input a date string, + 1day
Set expire times, input number type
// 1 second after, expirecookies // 1 minute 30 second after, expirecookies // 12 hour after, expirecookies // 1 month after, expirecookies
Set expire times - end of browser session
// end of session - use string!cookies
Set expire times , input string type
Unit | full name |
---|---|
y | year |
m | month |
d | day |
h | hour |
min | minute |
s | second |
✔ caseless for unit
❌ combination not supported
❌ double value not supported
// 60 second after, expirecookies // 30 minute after, expire, ignore casecookies // 24 day after, expirecookies // 4 month after, expirecookies // 16 hour after, expirecookies // 3 year after, expirecookies // input date string cookies cookies
Set expire support date
var date = date cookies
Set never expire
// never expirecookies // never expire , only -1,Other negative Numbers are invalidcookies
Set other arguments
// set pathcookies // set domain, default 1 day after,expirecookies // set securecookies
Other operation
// check a cookie existcookies // get a cookiecookies // remove a cookiecookies // get all cookie key names, line showscookies
Warning
Cookies
key names Cannot be set to ['expires','max-age','path','domain','secure']
Explaination
Cookies-ts is developed from vue-cookies without dependencies
License
MIT Copyright (c) 2016-present, ztytotoro