API.md

Draconarius

Kind: global class

• Draconarius
  • instance
    • .isEnabled(flag, ...args) ⇒ boolean
    • .updateFlag(flag, value)
    • .getAllFlags() ⇒ object
  • static
    • .Draconarius
      • new Draconarius(flags)
    • .version() ⇒ string

draconarius.isEnabled(flag, ...args) ⇒ boolean

isEnabled - To check if a flag is raised(enabled)

Kind: instance method of Draconarius
Returns: boolean - A boolean indicating if flag is enabled

Param	Type	Description
flag	string | array	The flag or flags you want to check
...args	array	optional arguments to pass to a flag function

draconarius.updateFlag(flag, value)

updateFlag - Update flag(s)

Kind: instance method of Draconarius

Param	Type	Description
flag	string | array	The flag or flags you want to check
value	function | boolean

draconarius.getAllFlags() ⇒ object

getAllFlags - Get all the flags currently set

Kind: instance method of Draconarius
Returns: object - All flags

Draconarius.Draconarius

Kind: static class of Draconarius

new Draconarius(flags)

Creates an instance of Draconarius.

Param	Type
flags	object | array

Draconarius.version() ⇒ string

version - Checks the version in package.json

Kind: static method of Draconarius
Returns: string - Current version of Draconarius