All the options that can be pass to dfuse Client factory createDfuseClient.
You dfuse API key to interact with the dfuse API service. You
can obtain and manage your API keys at
This is the self-management portal where all information
about your account can be found.
The API token store instance that should be use by the DfuseClient to retrieve and store the API token from. It's via this interface the API token is persisted and also retrieved from persistence storage when required.
undefined (the default), a LocalStorageApiTokenStore is
used when a Browser environment is detected, a OnDiskApiTokenStore is
used when a Node.js environment is detected and the InMemoryApiTokenStore
is used as a fallback if niether detection worked.
This is the authentication URL that will be reach to issue new API token.
The network to connect to. Can be a plain string in the set
mainnet | jungle | kylin. If it's not a string in this
set, the value is assumed to be an hostname pointing to the
the service, for example, your internal dfuse endpoint.
When it's a known network name, the hostname that is used will be the known hostname for this network name.
The final urls are constructed using
the DfuseClientOptions.secure option to determine which
protocol to use for HTTP (
http) and WebSocket
The refresh scheduler instance that should be used to schedule a token
refresh. This is more an internal details of the DfuseClient should
undefined for most user to pick a default refresh scheduler.
A function that generates a random request ID. This request ID is used when using the dfuse Stream API when no specific ID is passed at registration time.
Whether to use secure protocols or unsecure ones. This will control final URL constructed using this parameter value and the actual hostname as defined by the DfuseClientOptions.network value.
Generated using TypeDoc