Class: Provider
"providers/Provider".Provider
#
HierarchyProvider
↳ RelayProvider
#
Constructors#
constructor+ new Provider(ApiUrl
: string, WsApiUrl
: string): Provider
Defined in src/providers/Provider.ts:9
#
Parameters:Name | Type |
---|---|
ApiUrl | string |
WsApiUrl | string |
Returns: Provider
#
Properties#
ApiUrl• ApiUrl: string
Defined in src/providers/Provider.ts:8
#
WsApiUrl• WsApiUrl: string
Defined in src/providers/Provider.ts:9
#
Methods#
createWebsocketStreamâ–¸ createWebsocketStream(endpoint
: string, functionName
: string, args
: object, reconnectingOptions?
: ReconnectingWSOptions): Observable<any>
Defined in src/providers/Provider.ts:45
Creates a websocket stream connection to the server.
#
Parameters:Name | Type | Description |
---|---|---|
endpoint | string | Websocket stream endpoint to connect to. |
functionName | string | Function to call on connection. |
args | object | Function arguments. |
reconnectingOptions? | ReconnectingWSOptions | - |
Returns: Observable<any>
#
fetchEndpointâ–¸ fetchEndpoint<T>(endpoint
: string, options?
: object): Promise<T>
Defined in src/providers/Provider.ts:21
Returns a JSON response from the REST API of the server.
#
Type parameters:Name |
---|
T |
#
Parameters:Name | Type | Description |
---|---|---|
endpoint | string | Endpoint to fetch. |
options? | object | Optional fetch options. |
Returns: Promise<T>
#
getVersionâ–¸ getVersion(): Promise<string>
Defined in src/providers/Provider.ts:64
Returns the version of the currently configured provider server.
Returns: Promise<string>
Version of relay in the format <name>/vX.X.X
.
#
postToEndpointâ–¸ postToEndpoint<T>(endpoint
: string, data
: any): Promise<T>
Defined in src/providers/Provider.ts:29
#
Type parameters:Name |
---|
T |
#
Parameters:Name | Type |
---|---|
endpoint | string |
data | any |
Returns: Promise<T>