React Native Firebase
    Preparing search index...

    Functions

    execute

    Executes a pipeline and returns a Promise that resolves to the pipeline snapshot.

    pipelineResultEqual

    Compares two pipeline results for equality.

    Interfaces

    Pipeline

    Pipeline with chained stages. Each stage returns a new Pipeline (immutable chain).

    PipelineExecuteOptions

    Options for pipeline execute().

    PipelineResult

    Result of running a pipeline. One per document (or per group with aggregation, or single for global aggregation).

    PipelineSnapshot

    Snapshot returned from execute(pipeline).

    References

    abs → abs
    add → add
    AddFieldsStageOptions → AddFieldsStageOptions
    AggregateFunction → AggregateFunction
    AggregateStageOptions → AggregateStageOptions
    AliasedAggregate → AliasedAggregate
    AliasedExpression → AliasedExpression
    and → and
    array → array
    arrayAgg → arrayAgg
    arrayAggDistinct → arrayAggDistinct
    arrayConcat → arrayConcat
    arrayContains → arrayContains
    arrayContainsAll → arrayContainsAll
    arrayContainsAny → arrayContainsAny
    arrayGet → arrayGet
    arrayLength → arrayLength
    arraySum → arraySum
    ascending → ascending
    average → average
    BooleanExpression → BooleanExpression
    byteLength → byteLength
    ceil → ceil
    charLength → charLength
    CollectionGroupStageOptions → CollectionGroupStageOptions
    collectionId → collectionId
    CollectionStageOptions → CollectionStageOptions
    concat → concat
    conditional → conditional
    constant → constant
    cosineDistance → cosineDistance
    count → count
    countAll → countAll
    countDistinct → countDistinct
    countIf → countIf
    currentTimestamp → currentTimestamp
    DatabaseStageOptions → DatabaseStageOptions
    descending → descending
    DistinctStageOptions → DistinctStageOptions
    divide → divide
    documentId → documentId
    DocumentsStageOptions → DocumentsStageOptions
    dotProduct → dotProduct
    endsWith → endsWith
    equal → equal
    equalAny → equalAny
    euclideanDistance → euclideanDistance
    exists → exists
    exp → exp
    Expression → Expression
    ExpressionType → ExpressionType
    field → field
    Field → Field
    FindNearestStageOptions → FindNearestStageOptions
    first → first
    floor → floor
    FunctionExpression → FunctionExpression
    greaterThan → greaterThan
    greaterThanOrEqual → greaterThanOrEqual
    ifAbsent → ifAbsent
    ifError → ifError
    isAbsent → isAbsent
    isError → isError
    isType → isType
    join → join
    last → last
    length → length
    lessThan → lessThan
    lessThanOrEqual → lessThanOrEqual
    like → like
    LimitStageOptions → LimitStageOptions
    ln → ln
    log → log
    log10 → log10
    logicalMaximum → logicalMaximum
    logicalMinimum → logicalMinimum
    ltrim → ltrim
    map → map
    mapEntries → mapEntries
    mapGet → mapGet
    mapKeys → mapKeys
    mapMerge → mapMerge
    mapRemove → mapRemove
    mapSet → mapSet
    mapValues → mapValues
    maximum → maximum
    minimum → minimum
    mod → mod
    multiply → multiply
    not → not
    notEqual → notEqual
    notEqualAny → notEqualAny
    OffsetStageOptions → OffsetStageOptions
    or → or
    Ordering → OrderingHelper
    PipelineSource → PipelineSource
    pow → pow
    rand → rand
    regexContains → regexContains
    regexFind → regexFind
    regexFindAll → regexFindAll
    regexMatch → regexMatch
    RemoveFieldsStageOptions → RemoveFieldsStageOptions
    ReplaceWithStageOptions → ReplaceWithStageOptions
    reverse → reverse
    round → round
    rtrim → rtrim
    SampleStageOptions → SampleStageOptions
    Selectable → Selectable
    SelectStageOptions → SelectStageOptions
    SortStageOptions → SortStageOptions
    split → split
    sqrt → sqrt
    StageOptions → StageOptions
    startsWith → startsWith
    stringConcat → stringConcat
    stringContains → stringContains
    stringIndexOf → stringIndexOf
    stringRepeat → stringRepeat
    stringReplaceAll → stringReplaceAll
    stringReplaceOne → stringReplaceOne
    stringReverse → stringReverse
    substring → substring
    subtract → subtract
    sum → sum
    TimeGranularity → TimeGranularity
    timestampAdd → timestampAdd
    timestampSubtract → timestampSubtract
    timestampToUnixMicros → timestampToUnixMicros
    timestampToUnixMillis → timestampToUnixMillis
    timestampToUnixSeconds → timestampToUnixSeconds
    timestampTruncate → timestampTruncate
    toLower → toLower
    toUpper → toUpper
    trim → trim
    trunc → trunc
    type → type
    Type → Type
    UnionStageOptions → UnionStageOptions
    unixMicrosToTimestamp → unixMicrosToTimestamp
    unixMillisToTimestamp → unixMillisToTimestamp
    unixSecondsToTimestamp → unixSecondsToTimestamp
    UnnestStageOptions → UnnestStageOptions
    vectorLength → vectorLength
    WhereStageOptions → WhereStageOptions
    xor → xor

    Type Aliases

    OneOf

    Utility type: only one property of T may be set.