api.md

ConfigAPI

This class provides methods to access the config for Adobe I/O libraries.

Kind: global class

• ConfigAPI
  • .get([key], [source])
  • .set(key, value, [local])
  • .delete(key, [local])
  • .reload()
  • .getPipedData() ⇒ Promise.<string>
  • .dotenv(the)

configAPI.get([key], [source])

Gets the value for a key in the Config. If no parameters are specified, it will return all keys and values of the consolidated Config.

Kind: instance method of ConfigAPI

Param	Type	Default	Description
[key]	string	"''"	the key to get the value from
[source]	string		'global', 'local', or 'env'. Defaults to searching the consolidated config.

configAPI.set(key, value, [local])

Set the value for a key in the Config.

Kind: instance method of ConfigAPI

Param	Type	Default	Description
key	string		the key to set the value to
value	string		the value to save for the key
[local]	boolean	false	Set to true to save the value in the local config. Defaults to false (save to global config).

configAPI.delete(key, [local])

Delete a key and its value in the Config.

Kind: instance method of ConfigAPI

Param	Type	Default	Description
key	string		the key to delete the value from
[local]	boolean	false	Set to true to delete the value in the local config. Defaults to false (save to global config).

configAPI.reload()

Reload the Config from all the config file(s)

Kind: instance method of ConfigAPI

configAPI.getPipedData() ⇒ Promise.<string>

Pipe data from stdin.

Kind: instance method of ConfigAPI

configAPI.dotenv(the)

Hoists variables in the ./.env file to process.env

Kind: instance method of ConfigAPI

Param	Type	Description
the	Object	dotenv object