abstractSocketProvider <MessageEvent, CloseEvent, ErrorEvent, API>
Hierarchy
- Eip1193Provider<API>
- SocketProvider
Index
Constructors
publicconstructor
Type parameters
- MessageEvent
- CloseEvent
- ErrorEvent
- API: unknown = EthExecutionAPI
Parameters
socketPath: string
optionaloptions: object
optionalreconnectOptions: object
Returns SocketProvider<MessageEvent, CloseEvent, ErrorEvent, API>
Accessors
[symbol]
Returns boolean
Methods
publicconnect
Returns void
publicdisconnect
Parameters
optionalcode: number
optionaldata: string
Returns void
abstractgetStatus
Returns Web3ProviderStatus
publicon
Type parameters
- T = JsonRpcResult
Parameters
type: string
callback: Web3ProviderEventCallback<T>
Returns void
publiconce
Type parameters
- T = JsonRpcResult
Parameters
type: string
callback: Web3ProviderEventCallback<T>
Returns void
publicremoveAllListeners
Parameters
type: string
Returns void
publicremoveListener
Parameters
type: string
callback: Web3ProviderEventCallback<JsonRpcResult>
Returns void
publicrequest
Type parameters
- Method: string
- ResultType = Web3APIReturnType<API, Method>
Parameters
request: Web3APIPayload<API, Method>
Returns Promise<JsonRpcResponseWithResult<ResultType>>
publicreset
Returns void
send
Type parameters
- ResultType = JsonRpcResult
- P = unknown
Parameters
payload: JsonRpcPayload<P>
callback: (err?: null | Error, response?: JsonRpcResponse<ResultType, JsonRpcResult>) => void
Returns void
sendAsync
Type parameters
- R = JsonRpcResult
- P = unknown
Parameters
payload: JsonRpcPayload<P>
Returns Promise<JsonRpcResponse<R, JsonRpcResult>>
publicsupportsSubscriptions
Returns boolean
staticisWeb3Provider
Parameters
provider: unknown
Returns boolean