Cookie utility.
_createCookieHashStringhash
Formats a cookie value for an object containing multiple values.
hash
Object
An object of key-value pairs to create a string for.
A string suitable for use as a cookie value.
_createCookieStringname
value
encodeValue
options
Creates a cookie string that can be assigned into document.cookie.
The formatted cookie string.
_parseCookieHashtext
Parses a cookie hash string into an object.
text
String
The cookie hash string to parse (format: n1=v1&n2=v2).
An object containing entries for each cookie value.
_parseCookieStringtext
shouldDecode
options
Parses a cookie string into an object representing all accessible cookies.
An object containing entries for each accessible cookie.
_setDocnewDoc
Sets the document object that the cookie utility uses for setting
cookies. This method is necessary to ensure that the cookie utility
unit tests can pass even when run on a domain instead of locally.
This method should not be used otherwise; you should use
Y.config.doc to change the document that the cookie
utility uses for everyday purposes.
newDoc
Object
The object to use as the document.
existsname
Determines if the cookie with the given name exists. This is useful for Boolean cookies (those that do not follow the name=value convention).
name
String
The name of the cookie to check.
True if the cookie exists, false if not.
getname
options
Returns the cookie value for the given name.
name
String
The name of the cookie to retrieve.
options
Function | Object
(Optional) An object containing one or more cookie options: raw (true/false), reverseCookieLoading (true/false) and converter (a function). The converter function is run on the value before returning it. The function is not used if the cookie doesn't exist. The function can be passed instead of the options object for backwards compatibility. When raw is set to true, the cookie value is not URI decoded.
If no converter is specified, returns a string or null if the cookie doesn't exist. If the converter is specified, returns the value returned from the converter or null if the cookie doesn't exist.
getSubname
subName
converter
options
Returns the value of a subcookie.
name
String
The name of the cookie to retrieve.
subName
String
The name of the subcookie to retrieve.
converter
Function
(Optional) A function to run on the value before returning it. The function is not used if the cookie doesn't exist.
options
Object
(Optional) Containing one or more settings for cookie parsing.
If the cookie doesn't exist, null is returned. If the subcookie doesn't exist, null if also returned. If no converter is specified and the subcookie exists, a string is returned. If a converter is specified and the subcookie exists, the value returned from the converter is returned.
getSubsname
options
Returns an object containing name-value pairs stored in the cookie with the given name.
An object of name-value pairs if the cookie with the given name exists, null if it does not.
removename
options
Removes a cookie from the machine by setting its expiration date to sometime in the past.
The created cookie string.
removeSubname
subName
options
Removes a sub cookie with a given name.
name
String
The name of the cookie in which the subcookie exists.
subName
String
The name of the subcookie to remove.
options
Object
(Optional) An object containing one or more cookie options: path (a string), domain (a string), expires (a Date object), removeIfEmpty (true/false), and secure (true/false). This must be the same settings as the original subcookie.
The created cookie string.
setname
value
options
Sets a cookie with a given name and value.
name
String
The name of the cookie to set.
value
Any
The value to set for the cookie.
options
Object
(Optional) An object containing one or more cookie options: path (a string), domain (a string), expires (a Date object), secure (true/false), and raw (true/false). Setting raw to true indicates that the cookie should not be URI encoded before being set.
The created cookie string.
setSubname
subName
value
options
Sets a sub cookie with a given name to a particular value.
The created cookie string.