JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1886527
  • Score
    100M100P100Q196135F
  • License MIT

TypeScript definitions for cookie-parser

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@types/cookie-parser) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    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: Mon, 25 Nov 2024 21:02:24 GMT

    • Dependencies: none

    • Peer dependencies: @types/express

    Credits

    These definitions were written by Santi Albo, and BendingBender.