supercookie
v4.0.2
Published
A tool for managing and creating the most versatile cookies ever seen without all the fuss.
Downloads
26
Maintainers
Readme
SuperCookie
This module provides four management classes for saving and retrieving objects, arrays, and all current javascript primitives into a named cookie without issue.
Installation
To install, in terminal type
npm i --save supercookie
then, in your project,
import SuperCookie from 'supercookie';
Constructor
new SuperCookie(name)
Class Variables
name
type: String
The cookie being utilized by SuperCookie.value
type:String
Retrieves or sets the value for the cookie of the given name value.
NOTE: The following values cannot retrieve the current parameters of a cookie. They are defined within the SuperCookie, and modify the cookie accordingly, but until they are set these values are undefined.
path
type: String
The path value of the cookie.domain
type: String
Retrieves or sets the provided domain parameter for the cookie of the given namesecure
type: Boolean
Retrieves or sets the provided secure parameter for the cookie of the given nameexpires
type: Date||String
Retrieves or sets the provided expires paramemeter for the cookie of the given namemaxAge
type: Number
Retrieves or sets the provided max-age parameter for the cookie of the given namesameSite
type: String
Retrieves or sets the provided samesite parameter for the cookie of the given nameparameters
type: Object
Retrieves or sets the provided parameters for the cookie of the given name in the format of the names used here (ie: maxAge rather than "max-age")
Methods
- delete()
Deletes the cookie of the given name
Static Methods
set(name, value, [parameters])
Sets the cookie with the given name value to value with the parameters provided. parameters are in the naming format provided previously.get(name)
type: String Retrieves the value for the cookie of the name provided.delete(name)
Deletes the cookie of the given namegetFull()
type: Object Gets all cookies currently available as individual SuperCookies
Version History
3.0 - The rework for typescript and cookies building properly, complete with retyping for primitive object types, is good to go!
3.1 - Remodeled the constructor to not include value, as that is typically defined through usage and many times would require putting an undefined entry in the middle.
4.0 implemented the ability to utilize the cookieStore functionality.