Cookie

Simple cookie management.

Demos

Create, read and delete cookies.

<!-- Demo coming soon -->

import { Cookie, Utils } from 'Formstone';

Utils.ready(() =&gt; {
  // Demo coming soon
});

/* Demo coming soon */

Set global options by passing a valid object to the public .defaults() method.

Name	Type	Default	Description
`domain`	`string`	`null`	Cookie domain
`expires`	`number`	`604800000`	Expiration time in milliseconds (default 7 days)
`path`	`string`	`null`	Cookie path
`samesite`	`string`	`'Lax'`	SameSite attribute ('Strict', 'Lax', or 'None')
`secure`	`boolean`	`null`	Secure attribute (requires HTTPS)

Methods are publicly available, unless otherwise stated.

Name	Description
`.defaults()`	Sets default options for all future cookie operations
`.set()`	Sets a cookie value
`.get()`	Gets a cookie value by key
`.delete()`	Deletes a cookie

Sets default options for all future cookie operations.

Name	Type	Default	Description
`options`	`object` (required)	`{}`	Object containing default options

Cookie.defaults({
  expires: 3600000, // 1 hour
  secure: true
});

Sets a cookie value.

Name	Type	Default	Description
`key`	`string` (required)	`''`	Cookie key/name
`value`	`string` (required)	`''`	Cookie value
`options`	`object` (optional)	`{}`	Object containing options

// Set a basic cookie
Cookie.set('username', 'john');

// Set a cookie with custom options
Cookie.set('token', 'abc123', {
  expires: 3600000, // 1 hour
  secure: true,
  samesite: 'Strict'
});

Gets a cookie value by key.

Name	Type	Default	Description
`key`	`string` (required)	`''`	Cookie key/name

Type	Description
`string\|null`	Cookie value or null if not found

let username = Cookie.get('username');
if (username) {
  console.log('Welcome back, ' + username);
}

Deletes a cookie by setting its expiration to the past.

Name	Type	Default	Description
`key`	`string` (required)	`''`	Cookie key/name
`options`	`object` (optional)	`{}`	Object containing options (domain and path should match the original cookie)

Cookie.delete('username');

// Delete cookie with specific domain/path
Cookie.delete('token', {
  domain: '.example.com',
  path: '/'
});