Interface CookieStorage<Cookies>

Reads and writes cookies.

interface CookieStorage<
    Cookies extends Record<string, any> = Record<string, any>,
> {
    "[iterator]"(): Iterator<[string, any]>;
    clear(): void;
    delete(name: keyof Cookies): void;
    get<Name extends string | number | symbol>(
        name: Name,
    ): Cookies[Name] | undefined;
    getAll(): Partial<Cookies>;
    getNames(): (keyof Cookies)[];
    getSigned<Name extends string | number | symbol>(
        name: Name,
        secret: string | BufferSource,
    ): Promise<Cookies[Name] | undefined>;
    has(name: keyof Cookies): boolean;
    set<Name extends string | number | symbol>(
        name: Name,
        value: Cookies[Name],
        options?: CookieOptions,
    ): void;
    setSigned<Name extends string | number | symbol>(
        name: Name,
        value: Cookies[Name],
        secret: string | BufferSource,
        options?: CookieOptions,
    ): Promise<void>;
}

Type Parameters

Cookies extends Record<string, any> = Record<string, any>
Stored cookies.

Index

Methods

[iterator] clear delete get getAll getNames getSigned has set setSigned

Methods

[iterator]

"[iterator]"(): Iterator<[string, any]>
Iterates over existing cookies.

Returns Iterator<[string, any]>

clear

clear(): void
Deletes all cookies.

Returns void

delete

delete(name: keyof Cookies): void
Deletes cookie by its name.
Parameters
- name: keyof Cookies
  The cookie name.
Returns void

get

get<Name extends string | number | symbol>(
name: Name,
): Cookies[Name] | undefined
Returns a cookie value by its name.
Type Parameters
- Name extends string | number | symbol
Parameters
- name: Name
  The cookie name.
Returns Cookies[Name] | undefined

getAll

getAll(): Partial<Cookies>
Returns all cookies as name-value map.

Returns Partial<Cookies>

getNames

getNames(): (keyof Cookies)[]
Returns names of all existing cookies.

Returns (keyof Cookies)[]

getSigned

getSigned<Name extends string | number | symbol>(
name: Name,
secret: string | BufferSource,
): Promise<Cookies[Name] | undefined>
Returns a value of a cookie value that was signed, or undefined if there's no cookie with the given name, or it's signature cannot be verified.
Type Parameters
- Name extends string | number | symbol
Parameters
- name: Name
  The cookie name.
- secret: string | BufferSource
  The signing secret key.
Returns Promise<Cookies[Name] | undefined>
The cookie value, or undefined if there's no such cookie or signature verification has failed.

has

has(name: keyof Cookies): boolean
Returns true is a cookie with a given name exists.
Parameters
- name: keyof Cookies
  The cookie name.
Returns boolean

set

set<Name extends string | number | symbol>(
    name: Name,
    value: Cookies[Name],
    options?: CookieOptions,
): void
Sets a cookie value by its name.
Type Parameters
- Name extends string | number | symbol
Parameters
- name: Name
  The cookie name.
- value: Cookies[Name]
  The cookie value.
- Optionaloptions: CookieOptions
  Additional cookie options.
Returns void

setSigned

setSigned<Name extends string | number | symbol>(
    name: Name,
    value: Cookies[Name],
    secret: string | BufferSource,
    options?: CookieOptions,
): Promise<void>
Sets a signed cookie value.
Type Parameters
- Name extends string | number | symbol
Parameters
- name: Name
  The cookie name.
- value: Cookies[Name]
  The cookie value.
- secret: string | BufferSource
  The signing secret key.
- Optionaloptions: CookieOptions
  Additional cookie options.
Returns Promise<void>

Interface CookieStorage<Cookies>

Type Parameters

Index

Methods

Methods

[iterator]

Returns Iterator<[string, any]>

clear

Returns void

delete

Parameters

Returns void

get

Type Parameters

Parameters

Returns Cookies[Name] | undefined

getAll

Returns Partial<Cookies>

getNames

Returns (keyof Cookies)[]

getSigned

Type Parameters

Parameters

Returns Promise<Cookies[Name] | undefined>

has

Parameters

Returns boolean

set

Type Parameters

Parameters

Returns void

setSigned

Type Parameters

Parameters

Returns Promise<void>

Settings

On This Page