namespace

synapse

Source: index.js:31

Namespace

deviceAPI

Method

configure([customOptions])

Abstract type

ApiResponse

Namespace

Method

static

configure([customOptions]) → Object

sets the environement and region for the API

Parameters

Name Type Optional Description

customOptions

Object

Yes

Values in customOptions have the following properties:

Name Type Optional Description

ENV

string

Yes

Defaults to 'dev'.

AWS_REGION

string

Yes

Defaults to 'eu-central-1'.
Returns

Object the generated configuration for the given options

Abstract type

static

ApiResponse

API response in case of a successful API call

Properties

Name Type Optional Description

data

object

 

contains the server response

status

number

 

contains the server status code