JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1846737
  • Score
    100M100P100Q196546F
  • 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

    // Type definitions for cookie-parser 1.4
    // Project: https://github.com/expressjs/cookie-parser
    // Definitions by: Santi Albo <https://github.com/santialbo>
    //                 BendingBender <https://github.com/BendingBender>
    // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
    // TypeScript Version: 2.3
    
    import * as express from "express";
    
    declare global {
        namespace 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;
            }
        }
    }
    
    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, 04 Sep 2023 15:41:12 GMT
    • Dependencies: @types/express
    • Global values: none

    Credits

    These definitions were written by Santi Albo, and BendingBender.