Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ApiTokenStore

A simple API token store interface supporting async operations. This interface is used to store the API token when it has been refreshed as well as retrieving a token from the store.

By providing your own ApiTokenStore implementation, you can for example easily store the token in the localStorage (LocalStorageApiTokenStore), under ~/.dfuse/<sha256-api-key>/token.json file (OnDiskApiTokenStore) or more generically at any path (FileApiTokenStore).

Note The OnDiskApiTokenStore and FileApiTokenStore are available only on a Node.js environment.

kind

Interfaces

Hierarchy

  • ApiTokenStore

Implemented by

Index

Properties

Methods

Properties

get

get: function

Type declaration

set

set: function

Type declaration

Methods

release

  • release(): void
  • Release any resources hold by this ApiTokenStore instance. Must be tolerant to being called multiple times.

    Once called, the instance is assumed unsuable and should never be invoked anymore.

    Returns void

Generated using TypeDoc