Documentation GitHub

Global

Members

# VirtualDeviceType

Defines the possible types of virtual devices.

View Source model/virtual-device.ts, line 3

Methods

# isChannel(obj, logger, verbose) → {boolean}

Determines whether the specified object is a channel.

Parameters:
Name Type Description
obj object

The object to be tested
logger Logger

The logger instance to be used.
verbose boolean

Determines whether validation errors shall be logged. Default value is false.

View Source model/validator.ts, line 114

A value indicating whether the specified object is a channel.

boolean

# isConfiguration(obj, logger, verbose) → {boolean}

Determines whether the specified object is a configuration.

Parameters:
Name Type Description
obj object

The object to be tested
logger Logger

The logger instance to be used.
verbose boolean

Determines whether validation errors shall be logged. Default value is false.

View Source model/validator.ts, line 44

A value indicating whether the specified object is a configuration.

boolean

# isDevice(obj, logger, verbose) → {boolean}

Determines whether the specified object is a device.

Parameters:
Name Type Description
obj object

The object to be tested
logger Logger

The logger instance to be used.
verbose boolean

Determines whether validation errors shall be logged. Default value is false.

View Source model/validator.ts, line 124

A value indicating whether the specified object is a device.

boolean

# isDeviceList(obj, logger, verbose) → {boolean}

Determines whether the specified object is a device list.

Parameters:
Name Type Description
obj object

The object to be tested
logger Logger

The logger instance to be used.
verbose boolean

Determines whether validation errors shall be logged. Default value is false.

View Source model/validator.ts, line 54

A value indicating whether the specified object is a device list.

boolean

# isDeviceResponse(obj, logger, verbose) → {boolean}

Determines whether the specified object is a device response.

Parameters:
Name Type Description
obj object

The object to be tested
logger Logger

The logger instance to be used.
verbose boolean

Determines whether validation errors shall be logged. Default value is false.

View Source model/validator.ts, line 64

A value indicating whether the specified object is a device response.

boolean

# isGetDataPointResponse(obj, logger, verbose) → {boolean}

Determines whether the specified object is a valid response to a get data point request.

Parameters:
Name Type Description
obj object

The object to be tested
logger Logger

The logger instance to be used.
verbose boolean

Determines whether validation errors shall be logged. Default value is false.

View Source model/validator.ts, line 74

A value indicating whether the specified object is a response to a get data point request.

boolean

# isSetDataPointResponse(obj, logger, verbose) → {boolean}

Determines whether the specified object is a valid response to a set data point request.

Parameters:
Name Type Description
obj object

The object to be tested
logger Logger

The logger instance to be used.
verbose boolean

Determines whether validation errors shall be logged. Default value is false.

View Source model/validator.ts, line 84

A value indicating whether the specified object is a response to a set data point request.

boolean

# isVirtualDevice(obj, logger, verbose) → {boolean}

Determines whether the specified object is a virtual device.

Parameters:
Name Type Description
obj object

The object to be tested
logger Logger

The logger instance to be used.
verbose boolean

Determines whether validation errors shall be logged. Default value is false.

View Source model/validator.ts, line 94

A value indicating whether the specified object is a virtual device.

boolean

# isVirtualDeviceResponse(obj, logger, verbose) → {boolean}

Determines whether the specified object is a virtual device response.

Parameters:
Name Type Description
obj object

The object to be tested
logger Logger

The logger instance to be used.
verbose boolean

Determines whether validation errors shall be logged. Default value is false.

View Source model/validator.ts, line 104

A value indicating whether the specified object is a response to a virtual device request.

boolean

# isWebSocketMessage(obj, logger, verbose) → {boolean}

Determines whether the specified object is a web socket message.

Parameters:
Name Type Description
obj object

The object to be tested
logger Logger

The logger instance to be used.
verbose boolean

Determines whether validation errors shall be logged. Default value is false.

View Source model/validator.ts, line 34

A value indicating whether the specified object is a web socket message.

boolean

Type Definitions

"GET" | "POST" | "DELETE" | "PATCH" | "PUT"

# HttpRequestMethod

The HTTP request method

View Source system-access-point.ts, line 290