browser

interface

Browser

• cookie

  This object replaces the native document.cookie API and provides a setter/getter to set cookies on the top frame.

  BrowserCookie

• localStorage

  BrowserLocalStorage

• sendBeacon

  (url: string, body?: string) => Promise<boolean>

• sessionStorage

  BrowserSessionStorage

export interface Browser {
  /**
   * This object replaces the native document.cookie API and provides a
   * setter/getter to set cookies on the top frame.
   */
  cookie?: BrowserCookie;
  localStorage?: BrowserLocalStorage;

  /**
   * @deprecated The navigator.sendBeacon() method asynchronously sends an HTTP
   * POST request containing a small amount of data to a web server. Please use
   * the standard web `fetch` api with the option `keepalive: true` to achieve
   * this functionality.
   */
  sendBeacon?: (url: string, body?: string) => Promise<boolean>;
  sessionStorage?: BrowserSessionStorage;
}

BrowserCookie

This object replaces the native document.cookie API and provides a setter/getter to set cookies on the top frame.

• get

  An asynchronous method to get a specific cookie by name. Takes a cookie name of type `string` and returns the cookie value as a `string`

  (name?: string) => Promise<string>

• set

  An asynchronous method to set a cookie by name. It takes two arguments, a string of form `key=value` as [described here](https://developer.mozilla.org/en-US/docs/Web/API/Document/cookie#write_a_new_cookie) or the name of the cookie as the first argument and the value as the second argument.

  (cookieOrName: string, value?: string) => Promise<string>

export interface BrowserCookie {
  /**
   * An asynchronous method to get a specific cookie by name. Takes a cookie
   * name of type `string` and returns the cookie value as a `string`
   */
  get?: (name?: string) => Promise<string>;

  /**
   * An asynchronous method to set a cookie by name. It takes two arguments, a string of form `key=value` as [described here](https://developer.mozilla.org/en-US/docs/Web/API/Document/cookie#write_a_new_cookie) or the name of the cookie as the first argument and the value as the second argument.
   */
  set?: (cookieOrName: string, value?: string) => Promise<string>;
}

BrowserLocalStorage

• clear

  When invoked, will empty all keys out of the storage.

  () => Promise<void>

• getItem

  When passed a key name, will return that key's value.

  (key: string) => Promise<string>

• key

  When passed a number n, this method will return the name of the nth key in the storage.

  (index: number) => Promise<string>

• length

  Returns an integer representing the number of data items stored in the Storage object.

  () => Promise<number>

• removeItem

  When passed a key name, will remove that key from the storage.

  (key: string) => Promise<void>

• setItem

  When passed a key name and value, will add that key to the storage, or update that key's value if it already exists.

  (key: string, value: any) => Promise<void>

export interface BrowserLocalStorage {
  /**
   * When invoked, will empty all keys out of the storage.
   */
  clear?: () => Promise<ReturnType<WindowLocalStorage['localStorage']['clear']>>;

  /**
   * When passed a key name, will return that key's value.
   */
  getItem?: (
    key: string,
  ) => Promise<ReturnType<WindowLocalStorage['localStorage']['getItem']>>;

  /**
   * When passed a number n, this method will return the name of the nth key in
   * the storage.
   */
  key?: (
    index: number,
  ) => Promise<ReturnType<WindowLocalStorage['localStorage']['key']>>;

  /**
   * Returns an integer representing the number of data items stored in the
   * Storage object.
   */
  length?: () => Promise<WindowLocalStorage['localStorage']['length']>;

  /**
   * When passed a key name, will remove that key from the storage.
   */
  removeItem?: (
    key: string,
  ) => Promise<ReturnType<WindowLocalStorage['localStorage']['removeItem']>>;

  /**
   * When passed a key name and value, will add that key to the storage, or
   * update that key's value if it already exists.
   */
  setItem?: (
    key: string,
    value: any,
  ) => Promise<ReturnType<WindowLocalStorage['localStorage']['setItem']>>;
}

BrowserSessionStorage

• clear

  When invoked, will empty all keys out of the storage.

  () => Promise<void>

• getItem

  When passed a key name, will return that key's value.

  (key: string) => Promise<string>

• key

  When passed a number n, this method will return the name of the nth key in the storage.

  (index: number) => Promise<string>

• length

  Returns an integer representing the number of data items stored in the Storage object.

  () => Promise<number>

• removeItem

  When passed a key name, will remove that key from the storage.

  (key: string) => Promise<void>

• setItem

  When passed a key name and value, will add that key to the storage, or update that key's value if it already exists.

  (key: string, value: any) => Promise<void>

export interface BrowserSessionStorage {
  /**
   * When invoked, will empty all keys out of the storage.
   */
  clear?: () => Promise<
    ReturnType<WindowSessionStorage['sessionStorage']['clear']>
  >;

  /**
   * When passed a key name, will return that key's value.
   */
  getItem?: (
    key: string,
  ) => Promise<ReturnType<WindowSessionStorage['sessionStorage']['getItem']>>;

  /**
   * When passed a number n, this method will return the name of the nth key in
   * the storage.
   */
  key?: (
    index: number,
  ) => Promise<ReturnType<WindowSessionStorage['sessionStorage']['key']>>;

  /**
   * Returns an integer representing the number of data items stored in the
   * Storage object.
   */
  length?: () => Promise<WindowSessionStorage['sessionStorage']['length']>;

  /**
   * When passed a key name, will remove that key from the storage.
   */
  removeItem?: (
    key: string,
  ) => Promise<
    ReturnType<WindowSessionStorage['sessionStorage']['removeItem']>
  >;

  /**
   * When passed a key name and value, will add that key to the storage, or
   * update that key's value if it already exists.
   */
  setItem?: (
    key: string,
    value: any,
  ) => Promise<ReturnType<WindowSessionStorage['sessionStorage']['setItem']>>;
}