Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace firestore

Firebase Cloud Firestore Event Tools.

namespace

Index

Functions

Functions

Const addDocument

  • addDocument(collectionName: string, variable: Variable, callbackStateVariable?: Variable): void

Const deleteDocument

  • deleteDocument(collectionName: string, documentName: string, callbackStateVariable?: Variable): void

Const deleteField

  • deleteField(collectionName: string, documentName: string, field: string, callbackStateVariable?: Variable): void

Const executeQuery

  • executeQuery(queryID: string, callbackValueVariable?: Variable, callbackStatusVariable?: Variable): void

Const getDocument

  • getDocument(collectionName: string, documentName: string, callbackValueVariable?: Variable, callbackStateVariable?: Variable): void

Const getField

  • getField(collectionName: string, documentName: string, field: string, callbackValueVariable?: Variable, callbackStateVariable?: Variable): void

Const getServerTimestamp

  • getServerTimestamp(): string

Const hasDocument

  • hasDocument(collectionName: string, documentName: string, callbackValueVariable?: Variable, callbackStateVariable?: Variable): void

Const hasField

  • hasField(collectionName: string, documentName: string, field: string, callbackValueVariable?: Variable, callbackStateVariable?: Variable): void

Const listDocuments

  • listDocuments(collectionName: string, callbackValueVariable?: Variable, callbackStateVariable?: Variable): void

Const queryLimit

  • queryLimit(queryID: string, amount: number, last: boolean): void

  • Limits the amount of documents returned by the query.

    Parameters

    • queryID: string

      The query to add the filter to.

    • amount: number

      The amount of documents to limit to

    • last: boolean

      If true, limits to the last documents instead of the first documents.

    Returns void

Const queryOrderBy

  • queryOrderBy(queryID: string, field: string, direction: OrderByDirection): void

Const querySkipSome

  • querySkipSome(queryID: string, value: number, before: boolean, includeSelf: boolean): void

  • Makes a query skip documents after or before a certain value of a field the query was ordered with.

    Parameters

    • queryID: string

      The query to add the filter to.

    • value: number

      The value of the field ordered by.

    • before: boolean

      If set to true, all documents before the document are skipped, else all documents after it are skipped.

    • includeSelf: boolean

      If set to true, doesn't skip the document.

    Returns void

Const queryWhere

  • queryWhere(queryID: string, field: string, op: "<" | "<=" | "==" | "!=" | ">=" | ">" | "array-contains", value: string | number): void

  • Filters out documents whose fields do not match a condition from a query.

    Parameters

    • queryID: string

      The query to add the filter to.

    • field: string

      The field to run the condition on.

    • op: "<" | "<=" | "==" | "!=" | ">=" | ">" | "array-contains"

      The condition operator.

    • value: string | number

      The value to check against.

    Returns void

Const startQuery

  • startQuery(queryID: string, collectionName: string): void

Const startQueryFrom

  • startQueryFrom(queryID: string, sourceQueryID: string): void

Const updateDocument

  • updateDocument(collectionName: string, variableName: string, variable: Variable, callbackStateVariable?: Variable): void

Const updateField

  • updateField(collectionName: string, documentName: string, field: string, value: any, callbackStateVariable?: Variable): void

  • Updates a field of a document.

    Parameters

    • collectionName: string

      The collection where the document is stored.

    • documentName: string

      The name of the document where to update a field.

    • field: string

      The field where to update.

    • value: any

      The value to write.

    • Optional callbackStateVariable: Variable

    Returns void

Const watchQuery

  • watchQuery(queryID: string, callbackValueVariable?: Variable, callbackStatusVariable?: Variable): void

Const writeDocument

  • writeDocument(collectionName: string, variableName: string, variable: Variable, callbackStateVariable?: Variable): void

Const writeField

  • writeField(collectionName: string, documentName: string, field: string, value: any, callbackStateVariable?: Variable, merge?: boolean): void

  • Writes a field of a document.

    Parameters

    • collectionName: string

      The collection where to store the document.

    • documentName: string

      The name of the document where to write a field.

    • field: string

      The field where to write.

    • value: any

      The value to write.

    • Optional callbackStateVariable: Variable
    • merge: boolean = true

    Returns void

Generated using TypeDoc