Firestorm

Firestorm

Represents a Firestorm-powered server and its collections, tokens, and setup

Constructor

new Firestorm(paramsopt)

Description:

  • Create a new Firestorm instance

    • All parameters are optional and can be edited using the name, address, and token fields
Source:
Parameters:
Name Type Attributes Description
params FirestormCreationOption <optional>

Firestorm instance name, server address, and write token

Members

address :string

Source:
Type:
  • string

clientVersion :string

Description:

  • Get the current version of Firestorm

Source:

Get the current version of Firestorm

Type:
  • string

files :FirestormFiles

Description:

  • Firestorm file manager

Source:

Firestorm file manager

Type:
  • FirestormFiles

name :string

Source:
Type:
  • string

serverVersion :Promise.<string>

Description:

  • Get the version of Firestorm used on the provided server

Source:

Get the version of Firestorm used on the provided server

Type:
  • Promise.<string>

token :string

Source:
Type:
  • string

Methods

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>

(async) isCompatibleAddress() → {Promise.<boolean>}

Description:

  • Check whether the server-side Firestorm version is compatible with the client

Source:
Returns:
  • Whether the versions match
Type
Promise.<boolean>