TheRolfFR/firestorm-db: Self hosted Firestore-like database

firestorm

Source:

index.js, line 529

Namespaces

files

Members

(static) ID_FIELD

Description:

Value for the ID field when searching content

Source:

index.js, line 581

Value for the ID field when searching content

Methods

(static) address(newValueopt) → {string}

Description:

Change or get the current Firestorm address

Source:

index.js, line 538

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:

index.js, line 565

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) table(name) → {Collection.<T>}

Description:

Create a temporary Firestorm collection with no methods

Source:

index.js, line 576

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:

index.js, line 551

Parameters:

Name	Type	Attributes	Description
`newValue`	string	<optional>	The new Firestorm write token

Returns:

The stored Firestorm write token

Type: string