abstractWeb3Subscription <EventMap, ArgsType, API, CombinedEventMap>

Hierarchy

• Web3EventEmitter<CombinedEventMap>
  • Web3Subscription

Index

Constructors

• constructor

Properties

• args

Accessors

• id
• lastBlock

Methods

• _processSubscriptionError
• _processSubscriptionResult
• emit
• eventNames
• getMaxListeners
• listenerCount
• listeners
• off
• on
• once
• processSubscriptionData
• removeAllListeners
• resubscribe
• sendSubscriptionRequest
• sendUnsubscribeRequest
• setMaxListenerWarningThreshold
• subscribe
• unsubscribe

Constructors

publicconstructor

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

• Overrides Web3EventEmitter.constructor

  Type parameters

  • EventMap: Web3EventMap
  • ArgsType = any
  • API: unknown = EthExecutionAPI
  • CombinedEventMap: CommonSubscriptionEvents = EventMap & CommonSubscriptionEvents

  Parameters

  • args: ArgsType

  • options: { returnFormat?: DataFormat; subscriptionManager: Web3SubscriptionManager<unknown, {}> }

  Returns Web3Subscription<EventMap, ArgsType, API, CombinedEventMap>

Properties

publicreadonlyargs

args: ArgsType

Accessors

publicid

• get id(): undefined | string

• Returns undefined | string

publiclastBlock

• get lastBlock(): undefined | BlockOutput

• Returns undefined | BlockOutput

Methods

public_processSubscriptionError

• _processSubscriptionError(error: Error): void

• Parameters

  • error: Error

  Returns void

public_processSubscriptionResult

• _processSubscriptionResult(data: unknown): void

• Parameters

  • data: unknown

  Returns void

publicemit

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

• Inherited from Web3EventEmitter.emit

  Type parameters

  • K: string

  Parameters

  • eventName: K

  • params: CombinedEventMap[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): (...args: any[]) => void[]

• Inherited from Web3EventEmitter.listeners

  Type parameters

  • K: string

  Parameters

  • eventName: K

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

publicoff

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

• Inherited from Web3EventEmitter.off

  Type parameters

  • K: string

  Parameters

  • eventName: K

  • fn: Web3EventCallback<CombinedEventMap[K]>

  Returns void

publicon

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

• Inherited from Web3EventEmitter.on

  Type parameters

  • K: string

  Parameters

  • eventName: K

  • fn: Web3EventCallback<CombinedEventMap[K]>

  Returns void

publiconce

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

• Inherited from Web3EventEmitter.once

  Type parameters

  • K: string

  Parameters

  • eventName: K

  • fn: Web3EventCallback<CombinedEventMap[K]>

  Returns void

publicprocessSubscriptionData

• processSubscriptionData(data: JsonRpcSubscriptionResult | JsonRpcSubscriptionResultOld<Log> | JsonRpcNotification<Log>): void

• Parameters

  • data: JsonRpcSubscriptionResult | JsonRpcSubscriptionResultOld<Log> | JsonRpcNotification<Log>

  Returns void

publicremoveAllListeners

• removeAllListeners(): EventEmitter

• Inherited from Web3EventEmitter.removeAllListeners

  Returns EventEmitter

publicresubscribe

• resubscribe(): Promise<void>

• Returns Promise<void>

publicsendSubscriptionRequest

• sendSubscriptionRequest(): Promise<string>

• Returns Promise<string>

publicsendUnsubscribeRequest

• sendUnsubscribeRequest(): Promise<void>

• Returns Promise<void>

publicsetMaxListenerWarningThreshold

• setMaxListenerWarningThreshold(maxListenersWarningThreshold: number): void

• Inherited from Web3EventEmitter.setMaxListenerWarningThreshold

  Parameters

  • maxListenersWarningThreshold: number

  Returns void

publicsubscribe

• subscribe(): Promise<string>

• Returns Promise<string>

publicunsubscribe

• unsubscribe(): Promise<void>

• Returns Promise<void>