Namespace: cookie

cookie

Creating, reading and deleting cookies.

Based on jquery.cookie.js

Source:

Members

defaults :object

Default options

Type:
  • object
Source:

Methods

list() → {string[]}

List all currently set cookies.

Source:
Returns:

An array of the names of the cookies

Type
string[]

read(name, options) → {string|null}

Read the contents of a cookie.

Parameters:
Name Type Argument Description
name string

Name of the cookie to read

options object <optional>
Source:
Returns:

The contents of the cookie or null if the cookie was not found.

Type
string | null

remove(name)

Remove a cookie.

Parameters:
Name Type Description
name string

Name of the cookie to remove.

Source:

write(name, content, options)

Set a cookie with given content.

Parameters:
Name Type Argument Description
name string

Name of the cookie to set

content string

Content of the cookie

options object <optional>

Set the option "expires" to the number of days the cookie should be valid

Source:
Vorple Copyright © 2011-2014 the Vorple project
Documentation generated by JSDoc 3.2.2 on Wed May 07 2014 14:47:40 GMT+0300 (EEST) using the DocStrap template.