Logo for jsDocs.io

@types/cookie

  • Version 0.6.0
  • Published
  • 10.1 kB
  • No dependencies
  • MIT license

Install

npm i @types/cookie
yarn add @types/cookie
pnpm add @types/cookie

Overview

TypeScript definitions for cookie

Index

Functions

Interfaces

Functions

function parse

parse: (str: string, options?: CookieParseOptions) => Record<string, string>;

  • Parse an HTTP Cookie header string and returning an object of all cookie name-value pairs.

    Parameter str

    the string representing a Cookie header value

    Parameter options

    object containing parsing options

function serialize

serialize: (
    name: string,
    value: string,
    options?: CookieSerializeOptions
) => string;

  • Serialize a cookie name-value pair into a Set-Cookie header string.

    Parameter name

    the name for the cookie

    Parameter value

    value to set the cookie to

    Parameter options

    object containing serialization options

    Throws

    {TypeError} when maxAge options is invalid

Interfaces

interface CookieParseOptions

interface CookieParseOptions {}

  • Additional parsing options

method decode

decode: (value: string) => string;

  • Specifies a function that will be used to decode a cookie's value. Since the value of a cookie has a limited character set (and must be a simple string), this function can be used to decode a previously-encoded cookie value into a JavaScript string or other object.

    The default function is the global decodeURIComponent, which will decode any URL-encoded sequences into their byte representations.

    *Note* if an error is thrown from this function, the original, non-decoded cookie value will be returned as the cookie's value.

interface CookieSerializeOptions

interface CookieSerializeOptions {}

  • Additional serialization options

property domain

domain?: string | undefined;

  • Specifies the value for the Domain Set-Cookie attribute. By default, no domain is set, and most clients will consider the cookie to apply to only the current domain.

property expires

expires?: Date | undefined;

  • Specifies the Date object to be the value for the `Expires` `Set-Cookie` attribute. By default, no expiration is set, and most clients will consider this a "non-persistent cookie" and will delete it on a condition like exiting a web browser application.

    *Note* the cookie storage model specification states that if both expires and maxAge are set, then maxAge takes precedence, but it is possible not all clients by obey this, so if both are set, they should point to the same date and time.

property httpOnly

httpOnly?: boolean | undefined;

  • Specifies the boolean value for the `HttpOnly` `Set-Cookie` attribute. When truthy, the HttpOnly attribute is set, otherwise it is not. By default, the HttpOnly attribute is not set.

    *Note* be careful when setting this to true, as compliant clients will not allow client-side JavaScript to see the cookie in document.cookie.

property maxAge

maxAge?: number | undefined;

  • Specifies the number (in seconds) to be the value for the Max-Age Set-Cookie attribute. The given number will be converted to an integer by rounding down. By default, no maximum age is set.

    *Note* the cookie storage model specification states that if both expires and maxAge are set, then maxAge takes precedence, but it is possible not all clients by obey this, so if both are set, they should point to the same date and time.

property partitioned

partitioned?: boolean | undefined;

  • Specifies the boolean value for the [Partitioned Set-Cookie](rfc-cutler-httpbis-partitioned-cookies) attribute. When truthy, the Partitioned attribute is set, otherwise it is not. By default, the Partitioned attribute is not set.

    **note** This is an attribute that has not yet been fully standardized, and may change in the future. This also means many clients may ignore this attribute until they understand it.

    More information about can be found in [the proposal](https://github.com/privacycg/CHIPS)

property path

path?: string | undefined;

property priority

priority?: 'low' | 'medium' | 'high' | undefined;

  • Specifies the string to be the value for the [Priority Set-Cookie attribute][rfc-west-cookie-priority-00-4.1].

    - 'low' will set the Priority attribute to Low. - 'medium' will set the Priority attribute to Medium, the default priority when not set. - 'high' will set the Priority attribute to High.

    More information about the different priority levels can be found in [the specification][rfc-west-cookie-priority-00-4.1].

    **note** This is an attribute that has not yet been fully standardized, and may change in the future. This also means many clients may ignore this attribute until they understand it.

property sameSite

sameSite?: true | false | 'lax' | 'strict' | 'none' | undefined;

  • Specifies the boolean or string to be the value for the `SameSite` `Set-Cookie` attribute.

    - true will set the SameSite attribute to Strict for strict same site enforcement. - false will not set the SameSite attribute. - 'lax' will set the SameSite attribute to Lax for lax same site enforcement. - 'strict' will set the SameSite attribute to Strict for strict same site enforcement. - 'none' will set the SameSite attribute to None for an explicit cross-site cookie.

    More information about the different enforcement levels can be found in the specification.

    *note* This is an attribute that has not yet been fully standardized, and may change in the future. This also means many clients may ignore this attribute until they understand it.

property secure

secure?: boolean | undefined;

  • Specifies the boolean value for the `Secure` `Set-Cookie` attribute. When truthy, the Secure attribute is set, otherwise it is not. By default, the Secure attribute is not set.

    *Note* be careful when setting this to true, as compliant clients will not send the cookie back to the server in the future if the browser does not have an HTTPS connection.

method encode

encode: (value: string) => string;

  • Specifies a function that will be used to encode a cookie's value. Since value of a cookie has a limited character set (and must be a simple string), this function can be used to encode a value into a string suited for a cookie's value.

    The default function is the global encodeURIComponent, which will encode a JavaScript string into UTF-8 byte sequences and then URL-encode any that fall outside of the cookie range.

Package Files (1)

Dependencies (0)

No dependencies.

Dev Dependencies (0)

No dev dependencies.

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/cookie.

  • Markdown
    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/cookie)
  • HTML
    <a href="https://www.jsdocs.io/package/@types/cookie"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>