Class HttpProvider

Hierarchy

BaseProvider
- HttpProvider

Index

Constructors

constructor

Properties

Methods

Object literals

middlewares

Constructors

constructor

new HttpProvider(url: string, options?: any, fetcher?: any): HttpProvider

Overrides BaseProvider.__constructor
- Defined in harmony-network/src/providers/http.ts:24
Parameters
- url: string
- Optional options: any
- Optional fetcher: any
Returns HttpProvider

Properties

Optional fetcher

fetcher: any

Optional options

options: any

Protected reqMiddleware

reqMiddleware: ReqMiddleware = new Map().set('*', [])

Protected resMiddleware

resMiddleware: ResMiddleware = new Map().set('*', [])

url

url: string

Methods

callbackHandler

callbackHandler(data: any, cb: any): any

- Defined in harmony-network/src/providers/http.ts:139
function

callbackHandler

memberof

HttpProvider.prototype

Parameters
- data: any
  
  from server
- cb: any
  
  callback function
Returns any
- return object or callback function

endpointHandler

endpointHandler(obj: object, endpoint?: string): object

- Defined in harmony-network/src/providers/http.ts:108
function

endpointHandler

memberof

HttpProvider.prototype

Parameters
- obj: object
  
  payload object
- Optional endpoint: string
  
  add the endpoint to payload object
Returns object
- assign a new object

Protected getMiddleware

getMiddleware(method: RPCMethod | string): [ReqMiddleware[], ResMiddleware[]]

Inherited from BaseProvider.getMiddleware
- Defined in harmony-network/src/providers/baseProvider.ts:49
Parameters
- method: RPCMethod | string
Returns [ReqMiddleware[], ResMiddleware[]]

optionsHandler

optionsHandler(obj: object): object

- Defined in harmony-network/src/providers/http.ts:121
function

optionsHandler

memberof

HttpProvider.prototype

Parameters
- obj: object
  
  options object
Returns object
- assign a new option object

payloadHandler

payloadHandler(payload: RPCRequestPayload<object>): object

- Defined in harmony-network/src/providers/http.ts:97
function

payloadHandler

memberof

HttpProvider.prototype

Parameters
- payload: RPCRequestPayload<object>
  
  payload object
Returns object
- to payload object

Protected pushMiddleware

pushMiddleware(fn: any, type: MiddlewareType, match: string | RPCMethod | RegExp): void

Inherited from BaseProvider.pushMiddleware
- Defined in harmony-network/src/providers/baseProvider.ts:37
Parameters
- fn: any
- type: MiddlewareType
- match: string | RPCMethod | RegExp
Returns void

requestFunc

requestFunc(__namedParameters: { callback: any; endpoint: string; payload: RPCRequestPayload<object> }): Promise<any>

- Defined in harmony-network/src/providers/http.ts:65
Parameters
- __namedParameters: { callback: any; endpoint: string; payload: RPCRequestPayload<object> }
  - callback: any
  - endpoint: string
  - payload: RPCRequestPayload<object>
Returns Promise<any>

send

send(payload: RPCRequestPayload<object>, callback?: any): Promise<any>

- Defined in harmony-network/src/providers/http.ts:49
function

send

memberof

HttpProvider.prototype

Parameters
- payload: RPCRequestPayload<object>
  
  payload object
- Optional callback: any
  
  callback function
Returns Promise<any>
- RPC Response

sendServer

sendServer(endpoint: string, payload: RPCRequestPayload<object>, callback: any): Promise<any>

- Defined in harmony-network/src/providers/http.ts:61
function

sendServer

memberof

HttpProvider.prototype

Parameters
- endpoint: string
  
  endpoint to server
- payload: RPCRequestPayload<object>
  
  payload object
- callback: any
  
  callback function
Returns Promise<any>
- RPC Response

subscribe

subscribe(): void

- Defined in harmony-network/src/providers/http.ts:146
Returns void

unsubscribe

unsubscribe(): void

- Defined in harmony-network/src/providers/http.ts:150
Returns void

Object literals

middlewares

middlewares: object

request

request: object

use

use(fn: ReqMiddleware, match?: string | RPCMethod | RegExp): void

- Defined in harmony-network/src/providers/baseProvider.ts:13
Parameters
- fn: ReqMiddleware
- Default value match: string | RPCMethod | RegExp = "*"
Returns void

response

response: object

use

use(fn: ResMiddleware, match?: string | RPCMethod | RegExp): void

- Defined in harmony-network/src/providers/baseProvider.ts:18
Parameters
- fn: ResMiddleware
- Default value match: string | RPCMethod | RegExp = "*"
Returns void

Generated using TypeDoc