Class: WebConnect

Constructor

new WebConnect(optionsopt)

The LocalStorage class encapsulates the access to data objects.

Parameters:

Name	Type	Attributes	Description
`options`	Object	<optional>	options contains definitions for the datasource.

Since: 3.1.0
Copyright: schukai GmbH
License: AGPLv3

Example

import {WebConnect} from '@schukai/monster/source/data/datasource/server/webconnect.mjs';

const ds = new WebConnect({
    url: 'https://httpbin.org/get'
});

ds.set({flag: true})
ds.write().then(() => console.log('done'));
ds.read().then(() => console.log('done'));

Members

defaults

Properties

Name Type Default Description

url

string

Defines the resource that you wish to fetch.

connection

Object

Properties

Name	Type	Default	Description
`timeout`	Object	5000	Defines the timeout for the connection.
`reconnect.timeout`	Number		The timeout in milliseconds for the reconnect.
`reconnect.attempts`	Number		The maximum number of reconnects.
`reconnect.enabled`	Bool		If the reconnect is enabled.

write

Object

{}

Options

Properties

Name Type Description

mapping

Object

the mapping is applied before writing.

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 before writing.

sheathing

Object

Properties

Name	Type	Description
`object`	Object	Object to be wrapped
`path`	string	Path to the data

read

Object

{}

Options

Properties

Name Type Description

path

String

Path to data

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.

(static) instanceSymbol

This method is called by the instanceof operator.

Methods

close() → {Promise}

This method closes the connection.

Returns:

Type:: Promise

connect() → {Promise}

Returns:

Type:: Promise

getClone() → {RestAPI}

Returns:

Type:: RestAPI

isConnected() → {boolean}

Returns:

Type:: boolean

read() → {Promise}

Returns:

Type:: Promise

write() → {Promise}

Returns:

Type:: Promise