gantree.md

Gantree

Abstracted class used for library interaction.

Kind: global class

• Gantree
  • new Gantree()
  • .returnConfig(path) ⇒ object
  • .syncAll(gantreeConfigObj)
  • .cleanAll(gantreeConfigObj)

new Gantree()

Abstracted class used for library interaction.

gantree.returnConfig(path) ⇒ object

Validate, preprocess and return a Gantree configuration from a JSON file.

Kind: instance method of Gantree
Returns: object - gantreeConfigObj

Param	Type	Description
path	string	Path to a Gantree configuration, file must be JSON.

gantree.syncAll(gantreeConfigObj)

Create/update infrastructure in Gantree configuration.

Kind: instance method of Gantree

Param	Type	Description
gantreeConfigObj	object	Gantree configuration, must come from returnConfig.

gantree.cleanAll(gantreeConfigObj)

Destroy infrastructure in Gantree configuration.

Kind: instance method of Gantree

Param	Type	Description
gantreeConfigObj	object	Gantree configuration, must come from returnConfig.