Class HTTPCookieJar

Class for accessing and managing cookies in the associated request.

Hierarchy

HTTPCookieJar

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new HTTPCookieJar(request: Request): HTTPCookieJar

- Defined in src/http/kernel/HTTPCookieJar.ts:39
Parameters
- request: Request
Returns HTTPCookieJar

Properties

Protected parsed

parsed: {} = {}

The cookies parsed from the request.

Type declaration

[key: string]: HTTPCookie

Protected request

request: Request

Methods

clear

clear(name: string, options?: HTTPCookieOptions): HTTPCookieJar

- Defined in src/http/kernel/HTTPCookieJar.ts:93
Clears the given cookie.

Important: if the cookie was set with any options, the SAME options must be provided here in order for the cookie to be cleared on the client.

Parameters
- name: string
- Optional options: HTTPCookieOptions
Returns HTTPCookieJar

get

get(name: string): MaybeHTTPCookie

- Defined in src/http/kernel/HTTPCookieJar.ts:52
Gets the HTTPCookie by name, if it exists.

Parameters
- name: string
Returns MaybeHTTPCookie

getSetCookieHeaders

getSetCookieHeaders(): string[]

- Defined in src/http/kernel/HTTPCookieJar.ts:113
Get an array of Set-Cookie headers to include in the response.

Returns string[]

has

has(name: string): boolean

- Defined in src/http/kernel/HTTPCookieJar.ts:80
Returns true if a cookie exists with the given name.

Parameters
- name: string
Returns boolean

Private parseCookies

parseCookies(): void

- Defined in src/http/kernel/HTTPCookieJar.ts:170
Parse the cookies from the request.

Returns void

set

set(name: string, value: unknown, options?: HTTPCookieOptions): HTTPCookieJar

- Defined in src/http/kernel/HTTPCookieJar.ts:64
Set a new cookie using the specified options.

Parameters
- name: string
- value: unknown
- Optional options: HTTPCookieOptions
Returns HTTPCookieJar

extollo (v. latin) - to lift up, to elevate

Extollo is a free & libre application framework in TypeScript.