Table of Contents

Documentation / queries/ObservableQueryConnection

queries/ObservableQueryConnection

Classes

ObservableQueryConnection<TDataType>

Represents the connection for an observable query.

Type Parameters

TDataType

Implements

Constructors

new ObservableQueryConnection()

new ObservableQueryConnection<TDataType>(_route, _microservice): ObservableQueryConnection<TDataType>

Initializes a new instance of the <TDataType> class.

Parameters
_route

string

The relative route to use - relative to the current origin and protocol.

_microservice

string

Returns

ObservableQueryConnection<TDataType>

Defined in

queries/ObservableQueryConnection.ts:22

Methods

connect()

connect(dataReceived, queryArguments?): void

Connect to a specific route.

Parameters
dataReceived

DataReceived<TDataType>

queryArguments?

object

Returns

void

Implementation of

IObservableQueryConnection.connect

Defined in

queries/ObservableQueryConnection.ts:33

disconnect()

disconnect(): void

Disconnect the connection.

Returns

void

Implementation of

IObservableQueryConnection.disconnect

Defined in

queries/ObservableQueryConnection.ts:101

dispose()

dispose(): void

Disposes the connection.

Returns

void

Defined in

queries/ObservableQueryConnection.ts:28

Type Aliases

DataReceived()<TDataType>

DataReceived<TDataType>: (data) => void

Type Parameters

TDataType

Parameters

data

QueryResult<TDataType>

Returns

void

Defined in

queries/ObservableQueryConnection.ts:8