@metamask/polling-controller
Version:
Polling Controller is the base for controllers that polling by networkClientId
41 lines • 2.31 kB
text/typescript
import { BaseController } from "@metamask/base-controller";
import type { NetworkClientId, NetworkClient } from "@metamask/network-controller";
import type { Json } from "@metamask/utils";
import type { PollingTokenSetId } from "./types.cjs";
/**
* The minimum input required to start polling for a {@link BlockTrackerPollingController}.
* Implementing classes may provide additional properties.
*/
export type BlockTrackerPollingInput = {
networkClientId: NetworkClientId;
};
declare class Empty {
}
export declare const BlockTrackerPollingControllerOnly: <PollingInput extends BlockTrackerPollingInput>() => (abstract new (...args: any[]) => {
"__#13@#activeListeners": Record<string, (options: Json) => Promise<void>>;
_getNetworkClientById(networkClientId: NetworkClientId): NetworkClient | undefined;
_startPolling(input: PollingInput): void;
_stopPollingByPollingTokenSetId(key: PollingTokenSetId): void;
readonly "__#3@#pollingTokenSets": Map<string, Set<string>>;
"__#3@#callbacks": Map<string, Set<(input: PollingInput) => void>>;
_executePoll(input: PollingInput): Promise<void>;
startPolling(input: PollingInput): string;
stopAllPolling(): void;
stopPollingByPollingToken(pollingToken: string): void;
onPollingComplete(input: PollingInput, callback: (input: PollingInput) => void): void;
}) & typeof Empty;
export declare const BlockTrackerPollingController: <PollingInput extends BlockTrackerPollingInput>() => (abstract new (...args: any[]) => {
"__#13@#activeListeners": Record<string, (options: Json) => Promise<void>>;
_getNetworkClientById(networkClientId: NetworkClientId): NetworkClient | undefined;
_startPolling(input: PollingInput): void;
_stopPollingByPollingTokenSetId(key: PollingTokenSetId): void;
readonly "__#3@#pollingTokenSets": Map<string, Set<string>>;
"__#3@#callbacks": Map<string, Set<(input: PollingInput) => void>>;
_executePoll(input: PollingInput): Promise<void>;
startPolling(input: PollingInput): string;
stopAllPolling(): void;
stopPollingByPollingToken(pollingToken: string): void;
onPollingComplete(input: PollingInput, callback: (input: PollingInput) => void): void;
}) & typeof BaseController;
export {};
//# sourceMappingURL=BlockTrackerPollingController.d.cts.map