Class HttpsClient

HTTPS 1.1 Client that establishes an connection over a websocket. This client uses WASM for the TLS Encryption, WASM Module will be lazy loaded when the constructor is called.

Hierarchy (View Summary)

AbstractTlsConnection
- HttpsClient

Constructors

constructor

new HttpsClient(
hostname: string,
tlsSocketProvider: TlsWebSocketProvider,
): HttpsClient
Creates a TLS Client over WebSocket
Parameters
- hostname: string
  Hostname HttpHeader
- tlsSocketProvider: TlsWebSocketProvider
  A Class that can Create an TlsWebSocket to the correct target.
Returns HttpsClient
Overrides AbstractTlsConnection.constructor

Properties

`Protected`socket

socket: undefined | TlsWebSocket

`Protected`reader

reader: undefined | SocketReader

`Protected`timeout

timeout: number

debugEnabled

debugEnabled: boolean

set to debug HttpClient with console.log

onVerifyTlsConnection

onVerifyTlsConnection: (socket: TlsWebSocket) => Promise<void>

Hook method for double verify a connection aber the tls connection has been established.

Type Declaration

- (socket: TlsWebSocket): Promise<void>
- Parameters
  - socket: TlsWebSocket
    the new opened tls connection.
  Returns Promise<void>

`Protected`hostname

hostname: string

onResponse

onResponse: (response: HttpResponse) => void

Callback Method that gets the response bevor its processed by the user.

onStatusChange

onStatusChange: (status: HttpClientRequestStatus) => void

Callback Method that propagates the status of a HTTP Connection.

Methods

`Static`getHttpRequestString

getHttpRequestString(method: string, url: string, headers: HttpHeader[]): string
Builds the http Request String by parameter
Parameters
- method: string
  http method
- url: string
  Uri
- headers: HttpHeader[]
  Headers used in this request
Returns string
Complete request string

debug

debug(...args: unknown[]): void
Parameters
- ...args: unknown[]
Returns void
Inherited from AbstractTlsConnection.debug

getReader

getReader(): SocketReader
Returns SocketReader
Inherited from AbstractTlsConnection.getReader

setTimeoutRead

setTimeoutRead(timeout: number): void
Sets the read timeout in ms
Parameters
- timeout: number
  timeout in ms
Returns void
Inherited from AbstractTlsConnection.setTimeoutRead

getSocket

getSocket(): TlsWebSocket
Returns TlsWebSocket
Inherited from AbstractTlsConnection.getSocket

getTlsCertificateChain

getTlsCertificateChain(): undefined | string
Returns a PEM string containing of the certificate chain.

Returns undefined | string
PEM string.

Inherited from AbstractTlsConnection.getTlsCertificateChain

sendCommand

sendCommand(command: string): void
Parameters
- command: string
Returns void
Inherited from AbstractTlsConnection.sendCommand

`Protected`connectTlsClient

connectTlsClient(): Promise<void>
Waits for the WASM to be loaded, then starts the connection to the WebSocket after that tries to establish a tls connections.

Returns Promise<void>
a Promise that resolves after the TLS connection is established, and rejects in case of an error

Inherited from AbstractTlsConnection.connectTlsClient

`Protected`initClient

initClient(): void
Returns void

setHeader

setHeader(name: string, value: string): void
Parameters
- name: string
- value: string
Returns void

addHeader

addHeader(name: string, value: string): void
Parameters
- name: string
- value: string
Returns void

getHeaders

getHeaders(): HttpHeader[]
Returns HttpHeader[]

removeHeader

removeHeader(name: string): void
Parameters
- name: string
Returns void

webSocket

webSocket(path: string, protocols?: string[]): Promise<TunneledWebSocket>
Try to establish an Websocket connection threw the tls connection.
Parameters
- path: string
  Webserver path
- Optionalprotocols: string[]
  optional list of protocols for this socket.
Returns Promise<TunneledWebSocket>

get

get(path: string): Promise<HttpResponse>
Trigger a GET Request on the server.
Parameters
- path: string
  Path on the server, will be URL Encoded.
Returns Promise<HttpResponse>
HttpResponse

post

post(path: string, data: string | ArrayBufferLike): Promise<HttpResponse>
POST some Data to the server. Please be aware that some Servers may require you to set the "Content-Type" header. This will not be done automatically.
Parameters
- path: string
  URI Path (will be uri encoded)
- data: string | ArrayBufferLike
  Binary data or String that should be send to the client.
Returns Promise<HttpResponse>
Response from the server

put

put(path: string, data: string | ArrayBufferLike): Promise<HttpResponse>
PUT some Data to the server. Please be aware that some Servers may require you to set the "Content-Type" header. This will not be done automatically.
Parameters
- path: string
  URI Path (will be uri encoded)
- data: string | ArrayBufferLike
  Binary data or String that should be send to the client.
Returns Promise<HttpResponse>
Response from the server

delete

delete(path: string, data?: string | ArrayBufferLike): Promise<HttpResponse>
DELETE some Data to the server. Please be aware that some Servers may require you to set the "Content-Type" header. This will not be done automatically.
Parameters
- path: string
  URI Path (will be uri encoded)
- Optionaldata: string | ArrayBufferLike
  Binary data or String that should be send to the client.
Returns Promise<HttpResponse>
Response from the server

options

options(path: string): Promise<HttpResponse>
OPTIONS some Data to the server. Please be aware that some Servers may require you to set the "Content-Type" header. This will not be done automatically.
Parameters
- path: string
  URI Path (will be uri encoded)
Returns Promise<HttpResponse>
Response from the server

head

head(path: string): Promise<HttpResponse>
HEAD some Data to the server. Please be aware that some Servers may require you to set the "Content-Type" header. This will not be done automatically.
Parameters
- path: string
  URI Path (will be uri encoded)
Returns Promise<HttpResponse>
Response from the server

patch

patch(path: string, data: string | ArrayBufferLike): Promise<HttpResponse>
PATCH some Data to the server. Please be aware that some Servers may require you to set the "Content-Type" header. This will not be done automatically.
Parameters
- path: string
  URI Path (will be uri encoded)
- data: string | ArrayBufferLike
  Binary data or String that should be send to the client.
Returns Promise<HttpResponse>
Response from the server

fetch

fetch(
    method: string,
    path: string,
    data?: string | ArrayBufferLike,
): Promise<HttpResponse>
Parameters
- method: string
- path: string
- Optionaldata: string | ArrayBufferLike
Returns Promise<HttpResponse>

Class HttpsClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns HttpsClient

Properties

Protectedsocket

Protectedreader

Protectedtimeout

debugEnabled

onVerifyTlsConnection

Type Declaration

Parameters

Returns Promise<void>

Protectedhostname

onResponse

onStatusChange

Methods

StaticgetHttpRequestString

Parameters

Returns string

debug

Parameters

Returns void

getReader

Returns SocketReader

setTimeoutRead

Parameters

Returns void

getSocket

Returns TlsWebSocket

getTlsCertificateChain

Returns undefined | string

sendCommand

Parameters

Returns void

ProtectedconnectTlsClient

Returns Promise<void>

ProtectedinitClient

Returns void

setHeader

Parameters

Returns void

addHeader

Parameters

Returns void

getHeaders

Returns HttpHeader[]

removeHeader

Parameters

Returns void

webSocket

Parameters

Returns Promise<TunneledWebSocket>

get

Parameters

Returns Promise<HttpResponse>

post

Parameters

Returns Promise<HttpResponse>

put

Parameters

Returns Promise<HttpResponse>

delete

Parameters

Returns Promise<HttpResponse>

options

Parameters

Returns Promise<HttpResponse>

head

Parameters

Returns Promise<HttpResponse>

patch

Parameters

Returns Promise<HttpResponse>

`Protected`socket

`Protected`reader

`Protected`timeout

`Protected`hostname

`Static`getHttpRequestString

`Protected`connectTlsClient

`Protected`initClient