Class Cookie

Class representing a Cookie.

Index

Constructors

Properties

name options value

Methods

cloneWith getValue serialize setExpires setSecure create

Constructors

`Protected`constructor

new Cookie(name: string, value: unknown, options?: CookieOptions): Cookie
Parameters
- name: string
  Cookie name.
- value: unknown
  Cookie value.
- options: CookieOptions = {}
  Cookie options.
Returns Cookie

Properties

`Readonly`name

name: string

`Readonly`options

options: CookieOptions

`Readonly`value

value: unknown

Methods

cloneWith

cloneWith(value: unknown, options?: CookieOptions): Cookie
Clone the cookie with new name, value, and options.
Parameters
- value: unknown
  New cookie value.
- options: CookieOptions = {}
  New cookie options.
Returns Cookie
A new cookie instance.

getValue

getValue<ValueType = unknown>(): ValueType
Get the cookie value.
Type Parameters
- ValueType = unknown
Returns ValueType
The cookie value.

serialize

serialize(): string

Serialize the cookie value.

Returns string

setExpires

setExpires(value: Date): this
Set expiration date for the cookie.
Parameters
- value: Date
  Expiration date.
Returns this

setSecure

setSecure(value: boolean): this
Set secure flag for the cookie.
Parameters
- value: boolean
  Whether the cookie is secure.
Returns this

`Static`create

create(name: string, value: unknown, options?: CookieOptions): Cookie
Create a Cookie.
Parameters
- name: string
  Cookie name.
- value: unknown
  Cookie value.
- options: CookieOptions = {}
  Cookie options.
Returns Cookie