nookies

What is nookies?

Nookies is a simple utility for handling cookies in Next.js applications. It provides a straightforward API for setting, getting, and destroying cookies on both the client and server sides.

What are nookies's main functionalities?

Set a Cookie

This feature allows you to set a cookie in a Next.js application. The code sample demonstrates how to set a cookie named 'cookieName' with a value of 'cookieValue' that expires in 30 days.

const nookies = require('nookies');

// In a Next.js API route or getServerSideProps
export function handler(req, res) {
  nookies.set({ res }, 'cookieName', 'cookieValue', {
    maxAge: 30 * 24 * 60 * 60,
    path: '/',
  });
  res.end('Cookie set');
}

Get a Cookie

This feature allows you to retrieve a cookie in a Next.js application. The code sample demonstrates how to get the value of a cookie named 'cookieName'.

const nookies = require('nookies');

// In a Next.js API route or getServerSideProps
export function handler(req, res) {
  const cookies = nookies.get({ req });
  res.end(`Cookie value: ${cookies.cookieName}`);
}

Destroy a Cookie

This feature allows you to destroy a cookie in a Next.js application. The code sample demonstrates how to destroy a cookie named 'cookieName'.

const nookies = require('nookies');

// In a Next.js API route or getServerSideProps
export function handler(req, res) {
  nookies.destroy({ res }, 'cookieName');
  res.end('Cookie destroyed');
}

Other packages similar to nookies

cookie

The 'cookie' package is a simple, lightweight library for parsing and serializing cookies. It is more general-purpose and can be used in any Node.js application, not just Next.js. However, it does not provide the same level of integration with Next.js as nookies.

js-cookie

The 'js-cookie' package is a popular library for handling cookies in the browser. It provides a simple API for setting, getting, and removing cookies on the client side. Unlike nookies, it does not support server-side operations, making it less suitable for Next.js applications that require server-side cookie handling.

universal-cookie

The 'universal-cookie' package is designed to work in both browser and Node.js environments. It provides a consistent API for handling cookies on both the client and server sides. While it offers similar functionality to nookies, it is not specifically tailored for Next.js applications.

README

nookies :cookie:

A collection of cookie helpers for Next.js

Features

• ✨ SSR support, for setter, parser and destroy
• ⚙️ Custom Express server support
• 🪶 super light
• 🛡 perfect for authentication

Setting and destroying cookies also works on server-side.

Quick start

yarn add nookies

You can play with the example code here.

ServerSide cookies

import nookies from 'nookies'

export default function Me() {
  return <div>My profile</div>
}

export async function getServerSideProps(ctx) {
  // Parse
  const cookies = nookies.get(ctx)

  // Set
  nookies.set(ctx, 'fromGetInitialProps', 'value', {
    maxAge: 30 * 24 * 60 * 60,
    path: '/',
  })

  // Destroy
  // nookies.destroy(ctx, 'cookieName')

  return { cookies }
}

Client-only Cookies

import { parseCookies, setCookie, destroyCookie } from 'nookies'

function handleClick() {
  // Simply omit context parameter.
  // Parse
  const cookies = parseCookies()
  console.log({ cookies })

  // Set
  setCookie(null, 'fromClient', 'value', {
    maxAge: 30 * 24 * 60 * 60,
    path: '/',
  })

  // Destroy
  // destroyCookie(null, 'cookieName')
}

export default function Me() {
  return <button onClick={handleClick}>Set Cookie</button>
}

Custom Express server cookies

const express = require('express');
const dev = process.env.NODE_ENV !== 'production';
const app = next({ dev });
const handle = app.getRequestHandler();
const { parseCookies, setCookie, destroyCookie } = require('nookies');

app.prepare()
    .then(() => {
        const server = express();

        server.get('/page', (req, res) => {

          // Notice how the request object is passed
          const parsedCookies = parseCookies({ req });

          // Notice how the response object is passed
          setCookie({ res }, 'fromServer', 'value', {
            maxAge: 30 * 24 * 60 * 60,
            path: '/page',
          });

          // destroyCookie({ res }, 'fromServer');

          return handle(req, res);
        });

    );

Reference

For client side usage, omit the ctx parameter. You can do so by setting it to an empty object ({}), null or undefined.

parseCookies(ctx, options) or nookies.get(ctx, options)

• ctx: Next.js context || (Express request object)
• options:
  • decode: a custom resolver function (default: decodeURIComponent)

setCookie(ctx, name, value, options) or nookies.set(ctx, name, value, options)

Don't forget to end your response on the server with res.send().

• ctx: (Next.js context) || (Express request object)
• name: cookie name
• value: cookie value
• options:
  • domain
  • encode
  • expires
  • httpOnly
  • maxAge
  • path
  • sameSite
  • secure

destroyCookie(ctx, name, options) or nookies.destroy(ctx, 'token', options)

Don't forget to end your response on the server with res.send(). This might be the reason your cookie isn't removed.

• ctx: (Next.js context) || (Express response object)
• name: cookie name
• options:
  • domain
  • path

License

MIT