Web3SubscriptionManager <API, RegisteredSubs>

Index

Constructors

• constructor

Properties

• registeredSubscriptions
• requestManager

Accessors

• subscriptions

Methods

• addSubscription
• clear
• removeSubscription
• subscribe
• supportsSubscriptions
• unsubscribe

Constructors

publicconstructor

• new Web3SubscriptionManager<API, RegisteredSubs>(requestManager: Web3RequestManager<API>, registeredSubscriptions: RegisteredSubs): Web3SubscriptionManager<API, RegisteredSubs>

• Type parameters

  • API: unknown
  • RegisteredSubs: {}

  Parameters

  • requestManager: Web3RequestManager<API>

  • registeredSubscriptions: RegisteredSubs

  Returns Web3SubscriptionManager<API, RegisteredSubs>

Properties

publicreadonlyregisteredSubscriptions

registeredSubscriptions: RegisteredSubs

publicreadonlyrequestManager

requestManager: Web3RequestManager<API>

Accessors

publicsubscriptions

• get subscriptions(): Map<string, InstanceType<RegisteredSubs[keyof RegisteredSubs]>>

• Returns Map<string, InstanceType<RegisteredSubs[keyof RegisteredSubs]>>

Methods

publicaddSubscription

• addSubscription(sub: InstanceType<RegisteredSubs[keyof RegisteredSubs]>): Promise<void>

• Parameters

  • sub: InstanceType<RegisteredSubs[keyof RegisteredSubs]>

  Returns Promise<void>

publicclear

• clear(): void

• Returns void

publicremoveSubscription

• removeSubscription(sub: InstanceType<RegisteredSubs[keyof RegisteredSubs]>): Promise<string>

• Parameters

  • sub: InstanceType<RegisteredSubs[keyof RegisteredSubs]>

  Returns Promise<string>

publicsubscribe

• subscribe<T>(name: T, args?: ConstructorParameters<RegisteredSubs[T]>[0], returnFormat?: DataFormat): Promise<InstanceType<RegisteredSubs[T]>>

• Type parameters

  • T: string | number | symbol

  Parameters

  • name: T

  • optionalargs: ConstructorParameters<RegisteredSubs[T]>[0]

  • returnFormat: DataFormat = DEFAULT_RETURN_FORMAT

  Returns Promise<InstanceType<RegisteredSubs[T]>>

publicsupportsSubscriptions

• supportsSubscriptions(): boolean

• Returns boolean

publicunsubscribe

• unsubscribe(condition?: ShouldUnsubscribeCondition): Promise<string[]>

• Parameters

  • optionalcondition: ShouldUnsubscribeCondition

  Returns Promise<string[]>