gavel-gateway-js: Configuration

Configuration

The config is accessed and changed through the setConfig() function in the exports. The function accepts an optional ConfigOptions object as a parameter and returns a copy of the config.

To override any options of the config, simply pass a ConfigOptions object with the properties you want to override into the setConfig() function.

const newConfig = api.setConfig({
defaultTimeout: 15000,
allowCacheByDefault: false
});

The object returned by the function is a copy of the actual config. Changing the return values properties has no effect.

Most config options are just default parameters for RequestOptions. However, apiKeys and maxQueueLength both control behaviour not controllable through request options.

Generated using TypeDoc