The @types/cookie-parser package provides TypeScript type definitions for the cookie-parser middleware, which is used in Express applications for parsing Cookie header and populating req.cookies with an object keyed by the cookie names. Essentially, it enables strong typing for TypeScript projects using cookie-parser, ensuring that developers can work with cookies in a type-safe manner.

What are @types/cookie-parser's main functionalities?

Type Definitions for Cookie Parsing Middleware

This code demonstrates how to use the cookie-parser middleware in an Express application with TypeScript. The @types/cookie-parser package provides the necessary type definitions for TypeScript to understand and correctly type the `req.cookies` object, allowing for a more robust and error-free development experience.

import express from 'express';
import cookieParser from 'cookie-parser';

const app = express();
app.use(cookieParser());

app.get('/', (req, res) => {
  console.log(req.cookies);
  res.send('Cookies: ' + JSON.stringify(req.cookies));
});

app.listen(3000, () => console.log('Server running on port 3000'));

Other packages similar to @types/cookie-parser

Readme

Source

Installation

npm install --save @types/cookie-parser

Summary

This package contains type definitions for cookie-parser (https://github.com/expressjs/cookie-parser).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/cookie-parser.

index.d.ts

import * as express from "express";

declare module "express" {
    // Inject additional properties on express.Request
    interface Request {
        /**
         * This request's secret.
         * Optionally set by cookie-parser if secret(s) are provided.  Can be used by other middleware.
         * [Declaration merging](https://www.typescriptlang.org/docs/handbook/declaration-merging.html) can be used to add your own properties.
         */
        secret?: string | undefined;
        /** Parsed cookies that have not been signed */
        cookies: Record<string, any>;
        /** Parsed cookies that have been signed */
        signedCookies: Record<string, any>;
    }
}

declare function cookieParser(
    secret?: string | string[],
    options?: cookieParser.CookieParseOptions,
): express.RequestHandler;

declare namespace cookieParser {
    interface CookieParseOptions {
        decode?(val: string): string;
    }

    function JSONCookie(jsonCookie: string): object | undefined;

    function JSONCookies<T extends { [key: string]: string }>(jsonCookies: T): { [P in keyof T]: object | undefined };

    function signedCookie(cookie: string, secret: string | string[]): string | false;

    function signedCookies<T extends { [key: string]: string }>(
        cookies: T,
        secret: string | string[],
    ): { [P in keyof T]?: string | false };
}

export = cookieParser;

Additional Details

Last updated: Thu, 29 Feb 2024 19:35:43 GMT
Dependencies: @types/express

Credits

These definitions were written by Santi Albo, and BendingBender.

FAQs

What is @types/cookie-parser?

Is @types/cookie-parser popular?

Is @types/cookie-parser well maintained?

Last updated on 29 Feb 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install