abstractWeb3Subscription <EventMap, ArgsType, API>

Hierarchy

• Web3EventEmitter<EventMap>
  • Web3Subscription

Index

Constructors

• constructor

Properties

• args

Accessors

• id
• lastBlock

Methods

• emit
• eventNames
• getMaxListeners
• listenerCount
• listeners
• off
• on
• once
• removeAllListeners
• resubscribe
• setMaxListenerWarningThreshold
• subscribe
• unsubscribe

Constructors

publicconstructor

• new Web3Subscription<EventMap, ArgsType, API>(args: ArgsType, options: { requestManager: Web3RequestManager<API>; returnFormat?: DataFormat }): Web3Subscription<EventMap, ArgsType, API>

• Overrides Web3EventEmitter.constructor

  Type parameters

  • EventMap: Web3EventMap
  • ArgsType = any
  • API: unknown = EthExecutionAPI

  Parameters

  • args: ArgsType

  • options: { requestManager: Web3RequestManager<API>; returnFormat?: DataFormat }

  Returns Web3Subscription<EventMap, ArgsType, API>

Properties

publicreadonlyargs

args: ArgsType

Accessors

publicid

• get id(): undefined | string

• Returns undefined | string

publiclastBlock

• get lastBlock(): undefined | BlockOutput

• Returns undefined | BlockOutput

Methods

publicemit

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

• Inherited from Web3EventEmitter.emit

  Type parameters

  • K: string

  Parameters

  • eventName: K

  • params: EventMap[K]

  Returns void

publiceventNames

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

• Inherited from Web3EventEmitter.eventNames

  Returns (string | symbol)[]

publicgetMaxListeners

• getMaxListeners(): number

• Inherited from Web3EventEmitter.getMaxListeners

  Returns number

publiclistenerCount

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

• Inherited from Web3EventEmitter.listenerCount

  Type parameters

  • K: string

  Parameters

  • eventName: K

  Returns number

publiclisteners

• listeners<K>(eventName: K): Function[]

• Inherited from Web3EventEmitter.listeners

  Type parameters

  • K: string

  Parameters

  • eventName: K

  Returns Function[]

publicoff

• 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

publicon

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

• Inherited from Web3EventEmitter.on

  Type parameters

  • K: string

  Parameters

  • eventName: K

  • fn: Web3EventCallback<EventMap[K]>

  Returns void

publiconce

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

• Inherited from Web3EventEmitter.once

  Type parameters

  • K: string

  Parameters

  • eventName: K

  • fn: Web3EventCallback<EventMap[K]>

  Returns void

publicremoveAllListeners

• removeAllListeners(): EventEmitter

• Inherited from Web3EventEmitter.removeAllListeners

  Returns EventEmitter

publicresubscribe

• resubscribe(): Promise<void>

• Returns Promise<void>

publicsetMaxListenerWarningThreshold

• setMaxListenerWarningThreshold(maxListenersWarningThreshold: number): void

• Inherited from Web3EventEmitter.setMaxListenerWarningThreshold

  Parameters

  • maxListenersWarningThreshold: number

  Returns void

publicsubscribe

• subscribe(): Promise<void>

• Returns Promise<void>

publicunsubscribe

• unsubscribe(): Promise<void>

• Returns Promise<void>