Module: sapim

Methods

---

<static> createConfigFile(content [, global] [, overwrite])

Creates a .sapim configuration file.

Parameters:

Name	Type	Argument	Default	Description
content	Configuration			The content of the configuration file.
global	boolean	<optional>	false	Flag indicating if the configuration should be global.
overwrite	boolean	<optional>	false	Flag indicating if the existing configuration (if any) should be overwritten.

Source:

• index.js, line 67

---

<static> default( [config])

Factory function for the API tools class.

Parameters:

Name	Type	Argument	Description
config	Configuration	<optional>	The configuration used for creating the API tools. If ommited, the configuration is loaded from the environment and / or the file system.

Source:

• index.js, line 73

Returns:

The API tools class instance.

Type

ApiManager

---

<static> loadConfigFile(path)

Utility function for loading a configuration file.

Parameters:

Name	Type	Description
path	string	The path to the config file.

Source:

• index.js, line 21

Returns:

The resulting configuration or null if not found.

Type

Configuration