Namespace atropa

Container for all Glorious classes, functions, etc.
Defined in: <node_modules/atropa-header/src/atropa-header.js>.

Namespace Summary
Constructor Attributes	Constructor Name and Description
	atropa Container for all Glorious classes, functions, etc.

Method Summary
Method Attributes	Method Name and Description
<static>	atropa.removeNodeByReference(elementReference) Removes DOM Nodes.
<static>	atropa.requires(className, requirementFn, errorMessage) Pushes a requirement check into atropa.data.requirements.
<static>	atropa.setAsOptionalArg(defaultVal, optionalArg) Set default values for optional function parameters.
<static>	atropa.supportCheck(className, errorMessage) Checks whether this class has been marked as unsupported and throws an error if it has.

Namespace Detail

atropa

Container for all Glorious classes, functions, etc.
Author: Matthew Christopher Kastor-Inare III
☭ Hial Atropa!! ☭.

Method Detail

<static> atropa.removeNodeByReference(elementReference)

Removes DOM Nodes.
Defined in: <node_modules/atropa-removeNodeByReference/src/atropa-removeNodeByReference.js>.
Author: Matthew Christopher Kastor-Inare III
☭ Hial Atropa!! ☭.

Parameters:
{DOM Node} elementReference: A reference to the DOM Node you want to remove.

<static> atropa.requires(className, requirementFn, errorMessage)

Pushes a requirement check into atropa.data.requirements. The test tests whether the class is supported in this environment. Sets atropa.data[className]'s support to unsupported and error to errorMessage if the requirementFn returns false. The requirement checks will all be run after the library has loaded.
Author: Matthew Christopher Kastor-Inare III
☭ Hial Atropa!! ☭.

Parameters:
{String} className: The name of the class.
{Function} requirementFn: A function to test whether or not the class is supported in this environment. If supported, returns true otherwise return false.
{String} errorMessage: The error message to use when this class or its methods are called in unsupported environments. Defaults to: 'The atropa.' + className + ' class is unsupported in this environment.';

<static> {Mixed} atropa.setAsOptionalArg(defaultVal, optionalArg)

Set default values for optional function parameters.
Defined in: <node_modules/atropa-setAsOptionalArg/src/atropa-setAsOptionalArg.js>.
Author: Matthew Christopher Kastor-Inare III
☭ Hial Atropa!! ☭.

  // To set a default value for an optional parameter
  function(optionalArg) {
      var defaultVal = 'hello there!';
      optionalArg = atropa.setAsOptionalArg(defaultVal, optionalArg);
      return optionalArg;
  }

Parameters:
{Mixed} defaultVal: The default value to set.
{Mixed} optionalArg: A reference to the optional argument.

Returns:: {Mixed} Returns the default value supplied when the optional argument is undefined or null. Otherwise, the supplied optional argument is returned.

<static> atropa.supportCheck(className, errorMessage)

Checks whether this class has been marked as unsupported and throws an error if it has.
Author: Matthew Christopher Kastor-Inare III
☭ Hial Atropa!! ☭.

Parameters:
{String} className: The name of the class.
{String} errorMessage: Optional. A custom error message. Defaults to atropa.data[className].error

Classes

Namespace atropa