Interface CookiesStatic<T>

Readonlyattributes

Readonlyconverter

get

• get(name: string): string | T

  Read cookie

  Parameters

  • name: string

  Returns string | T
• get(): { [key: string]: string }

  Read all available cookies

  Returns { [key: string]: string }

remove

• remove(name: string, options?: CookieAttributes): void

  Delete cookie

  Parameters

  • name: string
  • Optionaloptions: CookieAttributes

  Returns void

set

• set(name: string, value: string | T, options?: CookieAttributes): string

  Create a cookie

  Parameters

  • name: string
  • value: string | T
  • Optionaloptions: CookieAttributes

  Returns string

withAttributes

• withAttributes(attributes: CookieAttributes): 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: CookieAttributes

  Returns CookiesStatic<T>

withConverter

• withConverter<TConv = string>(converter: Converter<TConv>): 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: Converter<TConv>

  Returns CookiesStatic<TConv>