Variable FieldValueConst

Type Declaration

• arrayRemove: function

  • arrayRemove(...elements: unknown[]): FieldValueType

    Returns a sentinel to remove elements from an array field.

    Parameters

    • ...elements: unknown[]

    Returns FieldValueType

• arrayUnion: function

  • arrayUnion(...elements: unknown[]): FieldValueType

    Returns a sentinel to union elements into an array field. Only adds elements not already present.

    Parameters

    • ...elements: unknown[]

    Returns FieldValueType

• delete: function

  • delete(): FieldValueType

    Returns a sentinel to delete a field.

    Returns FieldValueType

• increment: function

  • increment(amount: number): FieldValueType

    Returns a sentinel to increment a numeric field by the given amount.

    Parameters

    • amount: number

    Returns FieldValueType

• serverTimestamp: function

  • serverTimestamp(): FieldValueType

    Returns a sentinel to include a server-generated timestamp in the written data.

    Returns FieldValueType