Interface CookiesStatic<T>

Type Parameters

T = string

Hierarchy

CookiesStatic

Index

Properties

Methods

Properties

Readonly attributes

attributes: export=.CookieAttributes

Readonly converter

converter: Required<export=.Converter<string>>

Methods

get

get(name: string): undefined | string | T
get(): {}

Read cookie

Parameters
- name: string
Returns undefined | string | T
Read all available cookies

Returns {}
- [key: string]: string

remove

remove(name: string, options?: export=.CookieAttributes): void

Delete cookie

Parameters
- name: string
- Optional options: export=.CookieAttributes
Returns void

set

set(name: string, value: string | T, options?: export=.CookieAttributes): undefined | string

Create a cookie

Parameters
- name: string
- value: string | T
- Optional options: export=.CookieAttributes
Returns undefined | string

withAttributes

withAttributes(attributes: export=.CookieAttributes): export=.CookiesStatic<T>

Cookie attribute defaults can be set globally by creating an instance of the api via withAttributes(), or individually for each call to Cookies.set(...) by passing a plain object as the last argument. Per-call attributes override the default attributes.

Parameters
- attributes: export=.CookieAttributes
Returns export=.CookiesStatic<T>

withConverter

withConverter<TConv>(converter: export=.Converter<TConv>): export=.CookiesStatic<TConv>

Create a new instance of the api that overrides the default decoding implementation. All methods that rely in a proper decoding to work, such as Cookies.remove() and Cookies.get(), will run the converter first for each cookie. The returned string will be used as the cookie value.

Type Parameters
- TConv = string
Parameters
- converter: export=.Converter<TConv>
Returns export=.CookiesStatic<TConv>

Generated using TypeDoc