Methods

async static

getDocs() → Promise containing ApiResponse

returns the documentation of the OSPIN HTTP and MQTT API

Returns

Promise containing ApiResponse 

async static

getMetrics() → Promise containing ApiResponse

returns the xlsx file with metrics

Returns

Promise containing ApiResponse 

async static

logClientError(params) → Promise containing ApiResponse

logs a frontend errors to the backend

Parameters

Name Type Optional Description

params

Object

 

Values in params have the following properties:

Name Type Optional Description

error

Object

 

error.errorString

string

 

error.errorTime

string

 

error.lineNumber

string

 

error.functionName

string

 

error.userName

string

 

error.pathName

string

 

Returns

Promise containing ApiResponse