Skip to content
On this page

Interface: Provider ​

Toc Section

  1. Interfaces

Toc Description

Define the structure and expected behavior of the Provider, Subscription, and other types in the module.

Table of contents ​

Methods ​

Methods ​

request ​

▸ request<T>(data): Promise<ProviderApiResponse<T, string>>

Sends request to the provider.

Sub Category

Request Method

Type parameters ​

NameType
Textends keyof ProviderApi<Address>

Parameters ​

NameType
dataRawProviderRequest<T>

Returns ​

Promise<ProviderApiResponse<T, string>>

Defined in ​

src/index.ts:61


addListener ​

▸ addListener<T>(eventName, listener): Provider

Adds a listener for the specified event.

Sub Category

Event Listener Methods

Type parameters ​

NameType
Textends keyof ProviderEvents<Address>

Parameters ​

NameType
eventNameT
listener(data: RawProviderEventData<T>) => void

Returns ​

Provider

Defined in ​

src/index.ts:68


removeListener ​

▸ removeListener<T>(eventName, listener): Provider

Removes a listener for the specified event.

Type parameters ​

NameType
Textends keyof ProviderEvents<Address>

Parameters ​

NameType
eventNameT
listener(data: RawProviderEventData<T>) => void

Returns ​

Provider

Defined in ​

src/index.ts:72


on ​

▸ on<T>(eventName, listener): Provider

Sub Category

Event Management Methods

Type parameters ​

NameType
Textends keyof ProviderEvents<Address>

Parameters ​

NameType
eventNameT
listener(data: RawProviderEventData<T>) => void

Returns ​

Provider

Defined in ​

src/index.ts:77


once ​

▸ once<T>(eventName, listener): Provider

Type parameters ​

NameType
Textends keyof ProviderEvents<Address>

Parameters ​

NameType
eventNameT
listener(data: RawProviderEventData<T>) => void

Returns ​

Provider

Defined in ​

src/index.ts:78


prependListener ​

▸ prependListener<T>(eventName, listener): Provider

Type parameters ​

NameType
Textends keyof ProviderEvents<Address>

Parameters ​

NameType
eventNameT
listener(data: RawProviderEventData<T>) => void

Returns ​

Provider

Defined in ​

src/index.ts:79


prependOnceListener ​

▸ prependOnceListener<T>(eventName, listener): Provider

Type parameters ​

NameType
Textends keyof ProviderEvents<Address>

Parameters ​

NameType
eventNameT
listener(data: RawProviderEventData<T>) => void

Returns ​

Provider

Defined in ​

src/index.ts:80