universal-cookie

https://www.npmjs.com/package/universal-cookie
Admin
universal-cookie provides universal cookies for JavaScript, enabling seamless cookie management on...
Tokens:2,704
Snippets:8
Trust Score:9.6
Update:1 year ago
Show doc for...
Tokens:
Raw
### Browser Cookie Example

Source: https://www.npmjs.com/package/universal-cookie/index

Demonstrates how to use the universal-cookie library in a browser environment to set and get cookies.

```javascript
import Cookies from 'universal-cookie';

const cookies = new Cookies(null, { path: '/' });

cookies.set('myCat', 'Pacman');
console.log(cookies.get('myCat')); // Pacman
```

--------------------------------

### Install universal-cookie

Source: https://www.npmjs.com/package/universal-cookie/index

Instructions for installing the universal-cookie package using npm or via a script tag for browser usage.

```bash
npm install universal-cookie
```

```html
<script
  crossorigin
  src="https://unpkg.com/universal-cookie@7/umd/universalCookie.min.js"
></script>
```

--------------------------------

### Installation Command

Source: https://www.npmjs.com/package/universal-cookie/index

Command to install the universal-cookie package using npm.

```bash
npm i universal-cookie
```

--------------------------------

### Install universal-cookie-express

Source: https://www.npmjs.com/package/universal-cookie/-express

Installs the universal-cookie-express package using npm. This is the first step to integrate cookie handling into your Express application.

```bash
npm install universal-cookie-express --save
```

--------------------------------

### Express Middleware Usage Example

Source: https://www.npmjs.com/package/universal-cookie/-express

Demonstrates how to use the `cookiesMiddleware()` provided by `universal-cookie-express` in an Express application. It shows how to set up the middleware and access cookies via `req.universalCookies`.

```javascript
import express, { Request, Response } from 'express';
import cookiesMiddleware from 'universal-cookie-express';

const app = express();

app.use(cookiesMiddleware()).use(function (req: Request, res: Response) {
  // get the user cookies using universal-cookie
  req.universalCookies.get('myCat');
});
```

--------------------------------

### Server Cookie Example

Source: https://www.npmjs.com/package/universal-cookie/index

Illustrates using the universal-cookie library on the server-side to read cookies from request headers.

```javascript
import Cookies from 'universal-cookie';

const cookies = new Cookies(req.headers.cookie, { path: '/' });

console.log(cookies.get('myCat')); // Pacman or undefined if not set yet
```

--------------------------------

### Universal Cookies Class API

Source: https://www.npmjs.com/package/universal-cookie/index

Comprehensive API documentation for the Cookies class in the universal-cookie package. This covers initialization, getting, setting, removing, and managing cookie change listeners.

```APIDOC
Cookies Class API:

constructor([cookieHeader], [defaultSetOptions])
  - Creates a cookies context.
  - Parameters:
    - cookieHeader (string|object): Specify the cookie header or object.
    - defaultSetOptions (object): Specify the default options when setting cookies.
      + path (string): Cookie path. Use '/' for accessibility on all pages.
      + expires (Date): Absolute expiration date for the cookie.
      + maxAge (number): Relative max age of the cookie in seconds from client receipt.
      + domain (string): Domain for the cookie (e.g., sub.domain.com or .allsubdomains.com).
      + secure (boolean): Is only accessible through HTTPS.
      + httpOnly (boolean): Is only the server able to access the cookie. Note: Cannot be accessed from the browser.
      + sameSite (boolean|none|lax|strict): Strict or Lax enforcement.
      + partitioned (boolean): Indicates partitioned storage for the cookie.

get(name, [options])
  - Retrieves a cookie value.
  - Parameters:
    - name (string): The name of the cookie.
    - options (object):
      + doNotParse (boolean): If true, the cookie value will not be parsed into an object.
  - Returns: The cookie value or undefined if not found.

getAll([options])
  - Retrieves all cookies.
  - Parameters:
    - options (object):
      + doNotParse (boolean): If true, cookie values will not be parsed into objects.
  - Returns: An object containing all cookies.

set(name, value, [options])
  - Sets a cookie value.
  - Parameters:
    - name (string): The name of the cookie.
    - value (string|object): The value to set. Objects will be stringified.
    - options (object): Supports all cookie options from RFC 6265.
      + path (string): Cookie path. Use '/' for accessibility on all pages.
      + expires (Date): Absolute expiration date for the cookie.
      + maxAge (number): Relative max age of the cookie in seconds from client receipt.
      + domain (string): Domain for the cookie (e.g., sub.domain.com or .allsubdomains.com).
      + secure (boolean): Is only accessible through HTTPS.
      + httpOnly (boolean): Is only the server able to access the cookie. Note: Cannot be accessed from the browser.
      + sameSite (boolean|none|lax|strict): Strict or Lax enforcement.
      + partitioned (boolean): Indicates partitioned storage for the cookie.

remove(name, [options])
  - Removes a cookie.
  - Parameters:
    - name (string): The name of the cookie to remove.
    - options (object): Supports all cookie options from RFC 6265 for removal context.
      + path (string): Cookie path.
      + expires (Date): Absolute expiration date.
      + maxAge (number): Relative max age.
      + domain (string): Domain.
      + secure (boolean): Secure flag.
      + httpOnly (boolean): HttpOnly flag.
      + sameSite (boolean|none|lax|strict): SameSite enforcement.
      + partitioned (boolean): Partitioned storage.

addChangeListener(callback)
  - Adds a listener for cookie change events (set or removed).
  - Parameters:
    - callback (function): A function called with arguments: name, value, and options of the changed cookie.

removeChangeListener(callback)
  - Removes a listener from cookie change events.
  - Parameters:
    - callback (function): The callback function to remove.
```

--------------------------------

### universal-cookie API Methods

Source: https://www.npmjs.com/package/universal-cookie/index

Provides descriptions for key methods of the universal-cookie library, including listener management and cookie updates.

```APIDOC
removeAllChangeListeners()
  Removes all change listeners previously added with addChangeListener().

update()
  Reads back cookies from the browser and triggers change listeners. This is typically not needed as the library detects changes automatically.
```
Tokens:
Raw