RestAPI

Namespace for storages

Author: schukai GmbH

Classes

WriteError: the error is thrown by the rest api in case of error

Members

defaults

Properties

Name Type Default Description

url

string

Defines the resource that you wish to fetch.

write

Object

{}

Options

Properties

Name Type Default Description

init

Object

{}

An options object containing any custom settings that you want to apply to the request. The parameters are identical to those of the Request constructor

Properties

Name	Type	Default	Description
`method`	string	POST

acceptedStatus string [200,201

url

string

URL

mapping

Object

the mapping is applied before writing.

Properties

Name	Type	Description
`transformer`	String	Transformer to select the appropriate entries

report

Object

Properties

Name	Type	Description
`path`	String	Path to validations

mapping.callback

Array.<Monster.Data.Datasource~exampleCallback>

with the help of the callback, the structures can be adjusted before writing.

read.init

Object

{}

An options object containing any custom settings that you want to apply to the request. The parameters are identical to those of the Request constructor

Properties

Name	Type	Default	Description
`method`	string	GET

read.acceptedStatus string [200

read.url

string

URL

read.mapping

Object

the mapping is applied after reading.

Properties

Name	Type	Description
`transformer`	String	Transformer to select the appropriate entries
`callback`	Array.<Monster.Data.Datasource~exampleCallback>	with the help of the callback, the structures can be adjusted after reading.

Methods

getClone() → {RestAPI}

Returns:

Type:: RestAPI

read() → {Promise}

Throws:

the options does not contain a valid json definition
Type
Error
value is not a object
Type
TypeError
the data cannot be read
Type
Error

Returns:

Type:: Promise

write() → {Promise}

Throws:

the data cannot be written
Type WriteError

Returns:

Type:: Promise