Web3PromiEvent <ResolveType, EventMap>

Hierarchy

• Web3EventEmitter<EventMap>
  • Web3PromiEvent

Implements

• Promise<ResolveType>

Index

Constructors

• constructor

Properties

• [toStringTag]

Methods

• catch
• emit
• eventNames
• finally
• getMaxListeners
• listenerCount
• listeners
• off
• on
• once
• removeAllListeners
• setMaxListenerWarningThreshold
• then

Constructors

constructor

• new Web3PromiEvent<ResolveType, EventMap>(executor: PromiseExecutor<ResolveType>): Web3PromiEvent<ResolveType, EventMap>

• Overrides Web3EventEmitter.constructor

  Type parameters

  • ResolveType
  • EventMap: Web3EventMap

  Parameters

  • executor: PromiseExecutor<ResolveType>

  Returns Web3PromiEvent<ResolveType, EventMap>

Properties

[toStringTag]

[toStringTag]: Promise

Implementation of Promise.[toStringTag]

Methods

catch

• catch<TResult>(onrejected?: (reason: unknown) => TResult | PromiseLike<TResult>): Promise<ResolveType | TResult>

• Implementation of Promise.catch

  Type parameters

  • TResult = never

  Parameters

  • optionalonrejected: (reason: unknown) => TResult | PromiseLike<TResult>

  Returns Promise<ResolveType | TResult>

emit

• emit<K>(eventName: K, params: EventMap[K]): void

• Inherited from Web3EventEmitter.emit

  Type parameters

  • K: string

  Parameters

  • eventName: K

  • params: EventMap[K]

  Returns void

eventNames

• eventNames(): (string | symbol)[]

• Inherited from Web3EventEmitter.eventNames

  Returns (string | symbol)[]

finally

• finally(onfinally?: () => void): Promise<ResolveType>

• Implementation of Promise.finally

  Parameters

  • optionalonfinally: () => void

  Returns Promise<ResolveType>

getMaxListeners

• getMaxListeners(): number

• Inherited from Web3EventEmitter.getMaxListeners

  Returns number

listenerCount

• listenerCount<K>(eventName: K): number

• Inherited from Web3EventEmitter.listenerCount

  Type parameters

  • K: string

  Parameters

  • eventName: K

  Returns number

listeners

• listeners<K>(eventName: K): (...args: any[]) => void[]

• Inherited from Web3EventEmitter.listeners

  Type parameters

  • K: string

  Parameters

  • eventName: K

  Returns (...args: any[]) => void[]

off

• off<K>(eventName: K, fn: Web3EventCallback<EventMap[K]>): void

• Inherited from Web3EventEmitter.off

  Type parameters

  • K: string

  Parameters

  • eventName: K

  • fn: Web3EventCallback<EventMap[K]>

  Returns void

on

• on<K>(eventName: K, fn: Web3EventCallback<EventMap[K]>): this

• Overrides Web3EventEmitter.on

  Type parameters

  • K: string

  Parameters

  • eventName: K

  • fn: Web3EventCallback<EventMap[K]>

  Returns this

once

• once<K>(eventName: K, fn: Web3EventCallback<EventMap[K]>): this

• Overrides Web3EventEmitter.once

  Type parameters

  • K: string

  Parameters

  • eventName: K

  • fn: Web3EventCallback<EventMap[K]>

  Returns this

removeAllListeners

• removeAllListeners(): EventEmitter

• Inherited from Web3EventEmitter.removeAllListeners

  Returns EventEmitter

setMaxListenerWarningThreshold

• setMaxListenerWarningThreshold(maxListenersWarningThreshold: number): void

• Inherited from Web3EventEmitter.setMaxListenerWarningThreshold

  Parameters

  • maxListenersWarningThreshold: number

  Returns void

then

• then<TResult1, TResult2>(onfulfilled?: (value: ResolveType) => TResult1 | PromiseLike<TResult1>, onrejected?: (reason: unknown) => TResult2 | PromiseLike<TResult2>): Promise<TResult1 | TResult2>

• Implementation of Promise.then

  Type parameters

  • TResult1 = ResolveType
  • TResult2 = never

  Parameters

  • optionalonfulfilled: (value: ResolveType) => TResult1 | PromiseLike<TResult1>

  • optionalonrejected: (reason: unknown) => TResult2 | PromiseLike<TResult2>

  Returns Promise<TResult1 | TResult2>