Skip to main content

@idearium/cookie

Idearium cookie wrapper.

Installation​

$ yarn add -E @idearium/cookie

Beta installation​

If you need to install a beta version, you can:

$ yarn add -E @idearium/cookie@beta

Usage​

To use @idearium/cookie, simply require it at the top of your file.

@idearium/cookie exports a number of pure functions to help you work with cookies:

  • create - creates a cookie.
  • find - finds a cookie in a HTTP cookie header string.

create​

To create a new cookie:

const { create } = require('@idearium/cookie');

// Express middleware

app.use((req, res, next) => {
    const cookieStr = create({
        cookie: 'cookie string value',
        httpOnly: true, // default
        maxAge: 3600, // default
        name: 'foo',
        path: '/', // default
    });

    res.set('set-cookie', cookieStr);
});

The create function uses the cookie library in the background and can accept any serialize options listed there.

For example, to set secure=true:

const cookieStr = create({
    cookie: 'cookie string value',
    name: 'foo',
    secure: true, // false
});

find​

To find a specific cookie within the cookie header:

const { find } = require('@idearium/cookie');

const cookie = find({
    cookies: req.headers.cookie,
    name: 'foo',
});

// 'cookie string value'

The find function uses the cookie library in the background and can accept any parse options listed there.