firestorm

Namespace

firestorm

Source:

Members

(static) __default_instance :Firestorm

Source:
Type:

(static) files :FirestormFiles

Description:

  • Firestorm file manager

Source:

Firestorm file manager

Type:
  • FirestormFiles

(static) ID_FIELD

Description:

  • Value for the ID field when searching content

Source:

Value for the ID field when searching content

Methods

(static) address(newValueopt) → {string}

Description:

  • Change or get the current Firestorm address

Source:
Parameters:
Name Type Attributes Description
newValue string <optional>

The new Firestorm address
Returns:

The stored Firestorm address

Type
string

(static) collection(name, addMethodsopt) → {Collection.<T>}

Description:

  • Create a new Firestorm collection instance

Source:
Parameters:
Name Type Attributes Description
name string

The name of the collection
addMethods function <optional>

Additional methods and data to add to the objects
Returns:

The collection instance

Type
Collection.<T>

(static) create(paramsopt) → {Firestorm}

Description:

  • Create as new instance of Firestorm

Source:
Parameters:
Name Type Attributes Description
params FirestormCreationOption <optional>

Firestorm instance name, server address, and write token
Returns:

New Firestorm instance

Type
Firestorm

(static) table(name) → {Collection.<T>}

Description:

  • Create a temporary Firestorm collection with no methods

Source:
Deprecated:
  • Use collection with no second argument instead
Parameters:
Name Type Description
name string

The table name to get
Returns:

The table instance

Type
Collection.<T>

(static) token(newValueopt) → {string}

Description:

  • Change or get the current Firestorm token

Source:
Parameters:
Name Type Attributes Description
newValue string <optional>

The new Firestorm write token
Returns:

The stored Firestorm write token

Type
string