Request cookies

Cookies let you describe request state that is sent outside the URL and request body. In Mock Config, request cookies are available on request.cookies inside your handler.

Read A Cookie

Use request.cookies to access a cookie value:

import { rest } from 'mock-config-server';

const route = rest.get<{ cookies: { session?: string } }>('/profile', ({ request }) => {
  const session = request.cookies.session;

  if (!session) {
    return {
      error: 'Unauthorized'
    };
  }

  return {
    session
  };
});

Given a request with Cookie: session=abc123, the session value will be 'abc123'.

Cookies In Matchers

If you want to return different responses based on cookie values, use cookies in the route matcher.

import { rest } from 'mock-config-server';

const routes = [
  rest.get(
    '/profile',
    {
      name: 'John',
      role: 'admin'
    },
    {
      match: {
        cookies: {
          role: 'admin'
        }
      }
    }
  )
];

This lets you keep one real route while describing multiple scenarios based on cookie state.