Class WebsocketClient

The WebsocketClient has direct access to the server. It is used to simulate the client. This is usually executed on the client.

Hierarchy

WebsocketClient
- LoadingStatus

Index

Constructors

constructor

new WebsocketClient(prototype?): WebsocketClient
Parameters
- Optional prototype: {
  ___expectOutboundsCall: Function;
  }
  - ___expectOutboundsCall: Function
Returns WebsocketClient
- Defined in src/integration-testing/angular-integration/client/client.ts:16

Properties

`Private` _token

_token: string = ""

`Private` callback

callback: ((method, data, messageId) => any)

Type declaration

- (method, data, messageId): any
- Parameters
  - method: string
  - data: any
  - messageId: number
  Returns any

`Private` expectedMethods

expectedMethods: Map<string | number, Function> = ...

`Private` expectedMethodsRejectionCallback

expectedMethodsRejectionCallback: Map<number, Function> = ...

isConnected

isConnected: boolean = true

states wether the client is connected

Returns

true as the client is always connected during test runs

`Private` messageId

messageId: number = 0

`Private` outbounds

outbounds: Map<string, ((data, specificHash, inserted, updated, deleted, length, _client) => void)> = ...

Type declaration

- (data, specificHash, inserted, updated, deleted, length, _client): void
- Parameters
  - data: any
  - specificHash: number
  - inserted: any[]
  - updated: any[]
  - deleted: any[]
  - length: number
  - _client: WebsocketClient
  Returns void

pool

pool: {
WssConnected: boolean;
}

Reference to the current pool. A pool can be used to store and access data using Outbounds.

Type declaration

WssConnected: boolean

`Static` `Private` handles

handles: Map<string, DecorableFunction> = ...

Deprecated

`Static` `Private` onSuccessHandlers

onSuccessHandlers: {
callback: DecorableFunction;
regexp: RegExp;
}[] = []

Type declaration

callback: DecorableFunction
regexp: RegExp

Deprecated

Accessors

Token

get Token(): string
This is used to store the session token. It is automatically transmitted to the api once the client opens the connection. It can be used to authenticate the client.

Returns string
- Defined in src/integration-testing/angular-integration/client/client.ts:30
set Token(val): void
Parameters
- val: string
Returns void
- Defined in src/integration-testing/angular-integration/client/client.ts:33

Methods

auth

auth(token): void
Send the session token to the server
Parameters
- token: string
  
  client session token
Returns void
- Defined in src/integration-testing/angular-integration/client/client.ts:73

defineSocketCallback

defineSocketCallback(callback): void
Initializes the socket callback.
Parameters
- callback: ((method, data, messageId) => any)
  
  This callback will be called, once any message is sent from the ws api
  - - (method, data, messageId): any
    - Parameters
      
      method: string
      
      data: any
      
      messageId: number
      
      Returns any
Returns void
- Defined in src/integration-testing/angular-integration/client/client.ts:48

`Private` expectMethod

expectMethod(method, messageId?): Promise<unknown>
Can be used to wait for specific message responses
Parameters
- method: string
  
  Method of the expected message
- Optional messageId: number
  
  ID of the expected message
Returns Promise<unknown>
- Defined in src/integration-testing/angular-integration/client/client.ts:98

expectOutbound

expectOutbound(method, callback): void
This allows to listen for outbound data to be received.
Parameters
- method: string
  
  method label of the outbound
- callback: ((data, specificHash, inserted, updated, deleted, length, _client) => void)
  
  this is called once the data has been received
  - - (data, specificHash, inserted, updated, deleted, length, _client): void
    - Parameters
      
      data: any
      
      specificHash: number
      
      inserted: any[]
      
      updated: any[]
      
      deleted: any[]
      
      length: number
      
      _client: WebsocketClient
      
      Returns void
Returns void
- Defined in src/integration-testing/angular-integration/client/client.ts:186

`Private` invokeSuccessHandlers

invokeSuccessHandlers(method): void
This method is called whenever a request transaction (route) has been sent to the server and a response has been received

SuccessHandlers can be used to show notifications on the client device.
Parameters
- method: string
  
  method of the successfully executed method
Returns void
- Defined in src/integration-testing/angular-integration/client/client.ts:240

messageReceived

messageReceived(param0): void
This handles all received messages. Depending on expected message config and other route configuration, different methods are called.
Parameters
- param0: {
      data: any;
      deleted: any[];
      inserted: any[];
      length: number;
      messageId: number;
      method: string;
      specificHash: number;
      updated: any[];
  }
  
  message data
  - data: any
  - deleted: any[]
  - inserted: any[]
  - length: number
  - messageId: number
  - method: string
  - specificHash: number
  - updated: any[]
Returns void
- Defined in src/integration-testing/angular-integration/client/client.ts:112

send

send(method, data): Promise<any>
Transmit messages to the server.
Parameters
- method: string
  
  Method of the message
- data: any
  
  Data to be transmitted
Returns Promise<any>
the result sent from the server
- Defined in src/integration-testing/angular-integration/client/client.ts:84

`Protected` sendToSocket

sendToSocket(method, data): number
This handles received data. This is the first point of the transaction, that usually takes place on the clients device.
Parameters
- method: string
  
  Method of the message
- data: any
  
  Transmitted data
Returns number
the messageId (can be used to refer message responses)
- Defined in src/integration-testing/angular-integration/client/client.ts:62

`Static` onSuccess

onSuccess(callback, regexp): void
Parameters
- callback: DecorableFunction
- regexp: RegExp
Returns void

Deprecated
- Defined in src/integration-testing/angular-integration/client/client.ts:228

`Static` registerHandle

registerHandle(method, func): void
Parameters
- method: string
- func: DecorableFunction
Returns void

Deprecated
- Defined in src/integration-testing/angular-integration/client/client.ts:208

Class WebsocketClient

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional prototype: { ___expectOutboundsCall: Function; }

___expectOutboundsCall: Function

Returns WebsocketClient

Properties

Private _token

Private callback

Type declaration

Parameters

method: string

data: any

messageId: number

Returns any

Private expectedMethods

Private expectedMethodsRejectionCallback

isConnected

Returns

Private messageId

Private outbounds

Type declaration

Parameters

data: any

specificHash: number

inserted: any[]

updated: any[]

deleted: any[]

length: number

_client: WebsocketClient

Returns void

pool

Type declaration

WssConnected: boolean

Static Private handles

Deprecated

Static Private onSuccessHandlers

Type declaration

callback: DecorableFunction

regexp: RegExp

Deprecated

Accessors

Token

Returns string

Parameters

val: string

Returns void

Methods

auth

Parameters

token: string

Returns void

defineSocketCallback

Parameters

callback: ((method, data, messageId) => any)

Parameters

method: string

data: any

messageId: number

Returns any

Returns void

Private expectMethod

Parameters

method: string

Optional messageId: number

Returns Promise<unknown>

expectOutbound

Parameters

method: string

callback: ((data, specificHash, inserted, updated, deleted, length, _client) => void)

Parameters

data: any

specificHash: number

`Optional` prototype: {
___expectOutboundsCall: Function;
}

`Private` _token

`Private` callback

`Private` expectedMethods

`Private` expectedMethodsRejectionCallback

`Private` messageId

`Private` outbounds

`Static` `Private` handles

`Static` `Private` onSuccessHandlers

`Private` expectMethod

`Optional` messageId: number

`Private` invokeSuccessHandlers

param0: {
data: any;
deleted: any[];
inserted: any[];
length: number;
messageId: number;
method: string;
specificHash: number;
updated: any[];
}

`Protected` sendToSocket

`Static` onSuccess

`Static` registerHandle