Cookie <T>

Index

Constructors

• constructor

Accessors

• attributes

Methods

• get
• has
• list
• remove
• set

Constructors

constructor

• new Cookie<T>(__namedParameters?: CookieOptions<T>): Cookie<T>

• Type parameters

  • T: Record<string, any>

  Parameters

  • __namedParameters: CookieOptions<T> = {}

  Returns Cookie<T>

Accessors

attributes

• get attributes(): CookieAttributes
• set attributes(attributes: CookieAttributes): void

• Get cookie attributes

  ---

  Returns CookieAttributes

  cookie attributes

• Set cookie attributes

  ---

  Parameters

  • attributes: CookieAttributes

    cookie attributes

  Returns void

Methods

get

• get<Name>(name: Name): null | T[Name]

• Get cookie value

  ---

  Type parameters

  • Name: string

  Parameters

  • name: Name

    cookie name

  Returns null | T[Name]

  cookie value or null if cookie does not exist

has

• has<Name>(name: Name): boolean

• Check if cookie exists

  ---

  Type parameters

  • Name: string

  Parameters

  • name: Name

    cookie name

  Returns boolean

list

• list<Cookies>(): Cookies

• Get all cookies

  ---

  Type parameters

  • Cookies = T

  Returns Cookies

  all document cookies

remove

• remove<Name>(name: Name, attributes?: CookieDomainAttributes): void

• Remove cookie

  ---

  Type parameters

  • Name: string

  Parameters

  • name: Name

    cookie name

  • optionalattributes: CookieDomainAttributes

    cookie domain attributes

  Returns void

set

• set<Name>(name: Name, value: null | T[Name], attributes?: CookieAttributes): void

• Set cookie value

  ---

  Type parameters

  • Name: string

  Parameters

  • name: Name

    cookie name

  • value: null | T[Name]

    cookie value

  • optionalattributes: CookieAttributes

    cookie attributes

  Returns void