Module: wirelesstags

The cloud platform interface to the Wireless Tag platform. This module exports the constructor for the WirelessTagPlatform class.

See README for further documentation.

Source:

Members

(inner, constant) CONFIG_NAME :string

The name of the default configuration file in the executing user's home directory. Used by WirelessTagPlatform.loadConfig.

Type:
  • string
Default Value:
  • .wirelesstags
Source:

(inner, constant) ENV_PASSWORD :string

The environment variable containing the Wireless Tag API password. Used by WirelessTagPlatform.loadConfig.

Type:
  • string
Default Value:
  • WIRELESSTAG_API_PASSWORD
Source:

(inner, constant) ENV_USERNAME :string

The environment variable containing the Wireless Tag API user name. Used by WirelessTagPlatform.loadConfig.

Type:
  • string
Default Value:
  • WIRELESSTAG_API_USER
Source:

Type Definitions

apiCallback(error, resultopt)

Callback accepted by most API-querying methods.

Parameters:
Name Type Attributes Description
error Error

the error instance if one occurred
result Object <optional>

the result if success

Properties
Name Type Attributes Description
object Object

the object for which the value was returned
value <optional>

the value returned by the API-querying method; unless noted otherwise, this will be the same as what the Promise resolves to that the method returns, provided it is different from the object itself
Source: