Config - Documentation

Config

Global config class.

Usage node:

import {Config} from 'stellar-sdk';
Config.setAllowHttp(true);
Config.setTimeout(5000);

Usage browser:

StellarSdk.Config.setAllowHttp(true);
StellarSdk.Config.setTimeout(5000);

Constructor

new Config()

Source:

lib/config.js, line 30

Methods

(static) getTimeout() → {number}

Source:

lib/config.js, line 65

Returns:

Type:: number

timeout flag

(static) isAllowHttp() → {boolean}

Source:

lib/config.js, line 57

Returns:

Type:: boolean

allowHttp flag

(static) setAllowHttp(value) → {void}

Sets allowHttp flag globally. When set to true, connections to insecure http protocol servers will be allowed. Must be set to false in production. Default: false.

Source:

lib/config.js, line 38

Parameters:

Name	Type	Description
`value`	`boolean`	new allowHttp value

Returns:

Type:: void

(static) setDefault() → {void}

Sets all global config flags to default values.

Source:

lib/config.js, line 74

Returns:

Type:: void

(static) setTimeout(value) → {void}

Sets timeout flag globally. When set to anything besides 0, the request will timeout after specified time (ms). Default: 0.

Source:

lib/config.js, line 49

Parameters:

Name	Type	Description
`value`	`number`	new timeout value

Returns:

Type:: void