Cookie

To access cookies from your request, you can use the Cookie parameter.

INFO

This parameter automatically registers @fastify/cookie in your Fastify instance.

You can further configure the plugin by passing fastifyCookie to the Kita plugin options.

Cookies are always of type string.

src/routes/index.ts

import type { Cookie } from '@kitajs/runtime';

export function get(cookie: Cookie) {
  return `You used the header 'Cookie: cookie=${cookie}'!`;
}

Route Schema

{
  "paths": {
    "/": {
      "get": {
        "operationId": "getIndex",
        "responses": {
          "2XX": {
            "description": "Default Response",
            "content": {
              "application/json": { "schema": { "type": "string" } }
            }
          }
        }
      }
    }
  }
}

Custom name

You can customize the name of the cookie you want to access by passing a string literal as an argument to the Cookie parameter.

src/routes/index.ts

import type { Cookie } from '@kitajs/runtime';

// Access the cookie named 'token'
export function get(anything: Cookie<'token'>) {
  return `This is your token: ${anything}`;
}

Route Schema

{
  "paths": {
    "/": {
      "get": {
        "operationId": "getIndex",
        "responses": {
          "2XX": {
            "description": "Default Response",
            "content": {
              "application/json": { "schema": { "type": "string" } }
            }
          }
        }
      }
    }
  }
}

Default values

Default values can be used with Cookie.

src/routes/index.ts

import type { Cookie } from '@kitajs/runtime';

export function get(cookie: Cookie = 'Arthur') {
  return `Hello ${cookie}!`;
}

Route Schema

{
  "paths": {
    "/": {
      "get": {
        "operationId": "getIndex",
        "responses": {
          "2XX": {
            "description": "Default Response",
            "content": {
              "application/json": { "schema": { "type": "string" } }
            }
          }
        }
      }
    }
  }
}