Preparing search index...

    Type Alias WithHistoryApi

    type WithHistoryApi = {
        getHistoryApi?: (providerId?: string) => Promise<HistoryApi>;
    }

    Hierarchy

    Index

    Properties

    getHistoryApi?

    Properties

    getHistoryApi?: (providerId?: string) => Promise<HistoryApi>

    Returns a promise for a History API implementation, or rejects if unavailable. The property is optional to support explicitly older servers that do not have a history api provider.

    When called without arguments, returns a proxy to the default provider. When called with a provider id, returns that specific provider's HistoryApi instance.

    Type declaration

      • (providerId?: string): Promise<HistoryApi>

      • Parameters

        • OptionalproviderId: string

          Optional id of a specific history provider plugin. If omitted, returns the default provider.

        Returns Promise<HistoryApi>

        Promise that resolves to a HistoryApi instance if available, or rejects with an error if not.

    On This Page

    Properties