Interface Network

The Network aptitude provides access to network calls through Olive Helps

Hierarchy

Network

Index

Methods

Methods

decode

decode(encodedValue: Uint8Array, encoding: string): Promise<string>

- Defined in network/index.ts:35
Decoding provided value

Parameters
- encodedValue: Uint8Array
  
  Specified encoded value to decode
- encoding: string
Returns Promise<string>
A promise resolving with the decoded text

encode

encode(text: string, encoding: string): Promise<Uint8Array>

- Defined in network/index.ts:27
Encoding provided text

Parameters
- text: string
  
  Specified text to encode
- encoding: string
Returns Promise<Uint8Array>
A promise resolving with the encoded Uint8Array

httpRequest

httpRequest(request: HTTPRequest): Promise<HTTPResponse>

- Defined in network/index.ts:19
Generates a HTTP request with the provided configuration.

Parameters
- request: HTTPRequest
  
  The HTTP request to make.
Returns Promise<HTTPResponse>
A Promise resolving with the response.

webSocketConnect

webSocketConnect(socketConfiguration: SocketConfiguration): Promise<Socket>

- Defined in network/index.ts:43
Connects to a specified websocket

Parameters
- socketConfiguration: SocketConfiguration
  
  A configuration object defines websocket
Returns Promise<Socket>
A promise with Socket

Generated using TypeDoc