Class CookieCollection

Class representing a collection of Cookies.

Index

Constructors

constructor

Methods

add all clear get getValue has isEmpty remove secure setOptions setSecret update create

Constructors

`Protected`constructor

new CookieCollection(
    cookie?: string,
    options?: CookieOptions,
    secret?: string,
): CookieCollection
Create a CookieCollection.
Parameters
- Optionalcookie: string
  String cookie from header.
- options: CookieOptions = {}
  Cookies options.
- Optionalsecret: string
  Secret value to sign and unsign cookies.
Returns CookieCollection

Methods

add

add(name: string, value: unknown, options?: CookieOptions): this
Add a cookie to the collection.
Parameters
- name: string
  Cookie name.
- value: unknown
  Cookie value.
- options: CookieOptions = {}
  Cookie options.
Returns this

all

all<S extends boolean>(
serialize?: S,
): S extends true ? string[] : Record<string, unknown>
Get all cookies in the collection.
Type Parameters
- S extends boolean
Parameters
- serialize: S = ...
  If true, serialize the cookies.
Returns S extends true ? string[] : Record<string, unknown>

clear

clear(force?: boolean): this
Clear all cookies from the collection.
Parameters
- force: boolean = false
  If true, remove only from collection without setting expiry.
Returns this

get

get(name: string): Cookie
Get a cookie from the collection.
Parameters
- name: string
  Cookie name.
Returns Cookie
Cookie value.
get(name: string, fallback: Cookie): Cookie
Get a cookie from the collection.
Parameters
- name: string
  Cookie name.
- fallback: Cookie
  Fallback value if the cookie does not exist.
Returns Cookie
Cookie value.

getValue

getValue<ValueType = unknown>(name: string): ValueType
Get a cookie value from the collection.
Type Parameters
- ValueType = unknown
Parameters
- name: string
  Cookie name.
Returns ValueType
Cookie value.
getValue<ValueType = unknown>(name: string, fallback: ValueType): ValueType
Get a cookie value from the collection.
Type Parameters
- ValueType = unknown
Parameters
- name: string
  Cookie name.
- fallback: ValueType
  Fallback value if the cookie does not exist.
Returns ValueType
Cookie value.

has

has(name: string): boolean
Check if the collection has a cookie.
Parameters
- name: string
  Cookie name.
Returns boolean

isEmpty

isEmpty(): boolean

Check if the collection is empty.

Returns boolean

remove

remove(name: string, options?: CookieOptions, force?: boolean): this
Remove a cookie from the collection.
Parameters
- name: string
  Cookie name to remove.
- options: CookieOptions = {}
  Cookie options.
- force: boolean = false
  If true, remove only from collection without setting expiry.
Returns this

secure

secure(value?: boolean): this
Set secure flag for all cookies in the collection.
Parameters
- value: boolean = false
  Whether the cookies are secure.
Returns this

setOptions

setOptions(options: CookieOptions): this
Set options for all cookies in the collection.
Parameters
- options: CookieOptions
  Cookie options.
Returns this

setSecret

setSecret(value: string): this
Set secret for signing and unsigning cookies.
Parameters
- value: string
  Secret value.
Returns this

update

update(name: string, value: unknown, options?: CookieOptions): this
Update a cookie in the collection.
Parameters
- name: string
  Cookie name.
- value: unknown
  New cookie value.
- options: CookieOptions = {}
  Cookie options.
Returns this

`Static`create

create(
    cookie?: string,
    options?: CookieOptions,
    secret?: string,
): CookieCollection
Create a CookieCollection.
Parameters
- Optionalcookie: string
  String cookie from header.
- options: CookieOptions = {}
  Cookies options.
- Optionalsecret: string
  Secret value to sign and unsign cookies.
Returns CookieCollection

Class CookieCollection

Index

Constructors

Methods

Constructors

Protectedconstructor

Parameters

Returns CookieCollection

Methods

add

Parameters

Returns this

all

Type Parameters

Parameters

Returns S extends true ? string[] : Record<string, unknown>

clear

Parameters

Returns this

get

Parameters

Returns Cookie

Parameters

Returns Cookie

getValue

Type Parameters

Parameters

Returns ValueType

Type Parameters

Parameters

Returns ValueType

has

Parameters

Returns boolean

isEmpty

Returns boolean

remove

Parameters

Returns this

secure

Parameters

Returns this

setOptions

Parameters

Returns this

setSecret

Parameters

Returns this

update

Parameters

Returns this

Staticcreate

Parameters

Returns CookieCollection

Settings

On This Page

`Protected`constructor

`Static`create