Namespace database

Firebase Cloud database Event Tools.

namespace

Index

Functions

Functions

Const deleteField

deleteField(path: string, field: string, callbackStateVariable?: Variable): void

Deletes a field of a database variable.

Parameters
- path: string
  
  The name under which the variable will be saved (document name).
- field: string
  
  The field to delete.
- Optional callbackStateVariable: Variable
Returns void

Const deleteVariable

deleteVariable(path: string, callbackStateVariable?: Variable): void

Deletes a database variable.

Parameters
- path: string
  
  The name under which the variable will be saved (document name).
- Optional callbackStateVariable: Variable
Returns void

Const getField

getField(path: string, field: string, callbackValueVariable: Variable, callbackStateVariable?: Variable): void

Gets a field of a database variable and store it in a variable.

Parameters
- path: string
  
  The name under which the variable will be saved (document name).
- field: string
  
  The field to get.
- callbackValueVariable: Variable
  
  The variable where to store the result.
- Optional callbackStateVariable: Variable
Returns void

Const getVariable

getVariable(path: string, callbackValueVariable: Variable, callbackStateVariable?: Variable): void

Gets a database variable and store it in a variable.

Parameters
- path: string
  
  The name under which the variable will be saved (document name).
- callbackValueVariable: Variable
  
  The variable where to store the result.
- Optional callbackStateVariable: Variable
Returns void

Const hasField

hasField(path: string, field: string, callbackValueVariable: Variable, callbackStateVariable?: Variable): void

Checks for existence of a database variable.

Parameters
- path: string
  
  The name under which the variable will be saved (document name).
- field: string
  
  The field to check.
- callbackValueVariable: Variable
  
  The variable where to store the result.
- Optional callbackStateVariable: Variable
Returns void

Const hasVariable

hasVariable(path: string, callbackValueVariable: Variable, callbackStateVariable?: Variable): void

Checks for existence of a database variable.

Parameters
- path: string
  
  The name under which the variable will be saved (document name).
- callbackValueVariable: Variable
  
  The variable where to store the result.
- Optional callbackStateVariable: Variable
Returns void

Const updateField

updateField(path: string, field: string, value: string | number, callbackStateVariable?: Variable): void

Updates a field of a database variable.

Parameters
- path: string
  
  The name under which the variable will be saved (document name).
- field: string
  
  The field where to update.
- value: string | number
  
  The value to write.
- Optional callbackStateVariable: Variable
Returns void

Const updateVariable

updateVariable(path: string, variable: Variable, callbackStateVariable?: Variable): void

Updates a database variable.

Parameters
- path: string
  
  The name under which the variable will be saved (document name).
- variable: Variable
  
  The variable to update.
- Optional callbackStateVariable: Variable
Returns void

Const writeField

writeField(path: string, field: string, value: string | number, callbackStateVariable?: Variable): void

(Over)writes a field of a database variable.

Parameters
- path: string
  
  The path where to write the field.
- field: string
  
  What field to write.
- value: string | number
  
  The value to write.
- Optional callbackStateVariable: Variable
Returns void

Const writeVariable

writeVariable(path: string, variable: Variable, callbackStateVariable?: Variable): void

(Over)writes a variable in a collection as database variable.

Parameters
- path: string
  
  The path where to store the variable.
- variable: Variable
  
  The variable to write.
- Optional callbackStateVariable: Variable
Returns void

Generated using TypeDoc