WebSocketProvider <API>

Hierarchy

• SocketProvider<WebSocket.MessageEvent, WebSocket.CloseEvent, WebSocket.ErrorEvent, API>
  • WebSocketProvider

Index

Constructors

• constructor

Accessors

• [symbol]

Methods

• connect
• disconnect
• getStatus
• on
• once
• removeAllListeners
• removeListener
• request
• reset
• send
• sendAsync
• supportsSubscriptions
• isWeb3Provider

Constructors

constructor

• new WebSocketProvider<API>(socketPath: string, options?: object, reconnectOptions?: object): default<API>

• Inherited from SocketProvider.constructor

  Type parameters

  • API: unknown = EthExecutionAPI

  Parameters

  • socketPath: string

  • optionaloptions: object

  • optionalreconnectOptions: object

  Returns default<API>

Accessors

[symbol]

• get [symbol](): boolean

• Inherited from SocketProvider.__@symbol@41960

  Returns boolean

Methods

connect

• connect(): void

• Inherited from SocketProvider.connect

  Returns void

disconnect

• disconnect(code?: number, data?: string): void

• Inherited from SocketProvider.disconnect

  Parameters

  • optionalcode: number

  • optionaldata: string

  Returns void

publicgetStatus

• getStatus(): Web3ProviderStatus

• Overrides SocketProvider.getStatus

  Returns Web3ProviderStatus

on

• on<T>(type: string, callback: Web3ProviderEventCallback<T>): void

• Inherited from SocketProvider.on

  Type parameters

  • T = JsonRpcResult

  Parameters

  • type: string

  • callback: Web3ProviderEventCallback<T>

  Returns void

once

• once<T>(type: string, callback: Web3ProviderEventCallback<T>): void

• Inherited from SocketProvider.once

  Type parameters

  • T = JsonRpcResult

  Parameters

  • type: string

  • callback: Web3ProviderEventCallback<T>

  Returns void

removeAllListeners

• removeAllListeners(type: string): void

• Inherited from SocketProvider.removeAllListeners

  Parameters

  • type: string

  Returns void

removeListener

• removeListener(type: string, callback: Web3ProviderEventCallback<JsonRpcResult>): void

• Inherited from SocketProvider.removeListener

  Parameters

  • type: string

  • callback: Web3ProviderEventCallback<JsonRpcResult>

  Returns void

request

• request<Method, ResultType>(request: Web3APIPayload<API, Method>): Promise<JsonRpcResponseWithResult<ResultType>>

• Inherited from SocketProvider.request

  Type parameters

  • Method: string
  • ResultType = Web3APIReturnType<API, Method>

  Parameters

  • request: Web3APIPayload<API, Method>

  Returns Promise<JsonRpcResponseWithResult<ResultType>>

reset

• reset(): void

• Inherited from SocketProvider.reset

  Returns void

send

• send<ResultType, P>(payload: JsonRpcPayload<P>, callback: (err?: null | Error, response?: JsonRpcResponse<ResultType, JsonRpcResult>) => void): void

• Inherited from SocketProvider.send

  Type parameters

  • ResultType = JsonRpcResult
  • P = unknown

  Parameters

  • payload: JsonRpcPayload<P>

  • callback: (err?: null | Error, response?: JsonRpcResponse<ResultType, JsonRpcResult>) => void

  Returns void

sendAsync

• sendAsync<R, P>(payload: JsonRpcPayload<P>): Promise<JsonRpcResponse<R, JsonRpcResult>>

• Inherited from SocketProvider.sendAsync

  Type parameters

  • R = JsonRpcResult
  • P = unknown

  Parameters

  • payload: JsonRpcPayload<P>

  Returns Promise<JsonRpcResponse<R, JsonRpcResult>>

supportsSubscriptions

• supportsSubscriptions(): boolean

• Inherited from SocketProvider.supportsSubscriptions

  Returns boolean

staticisWeb3Provider

• isWeb3Provider(provider: unknown): boolean

• Inherited from SocketProvider.isWeb3Provider

  Parameters

  • provider: unknown

  Returns boolean