React Native Firebase
Documentation
GitHub
npm
Preparing search index...
@react-native-firebase/firestore
pipelines/expressions
VariableExpression
Interface VariableExpression
Beta
Variable expression returned by
variable(...)
.
interface
VariableExpression
{
_brand
?:
"VariableExpression"
;
selectable
:
true
;
add
(
value
:
Expression
)
:
FunctionExpression
;
add
(
value
:
unknown
)
:
FunctionExpression
;
arrayAgg
()
:
Accumulator
;
arrayAggDistinct
()
:
Accumulator
;
arrayFilter
(
alias
:
string
,
filter
:
BooleanExpression
)
:
FunctionExpression
;
arrayFirst
()
:
FunctionExpression
;
arrayFirstN
(
n
:
number
|
Expression
)
:
FunctionExpression
;
arrayIndexOf
(
search
:
unknown
)
:
FunctionExpression
;
arrayIndexOfAll
(
search
:
unknown
)
:
FunctionExpression
;
arrayLast
()
:
FunctionExpression
;
arrayLastIndexOf
(
search
:
unknown
)
:
FunctionExpression
;
arrayLastN
(
n
:
number
|
Expression
)
:
FunctionExpression
;
arrayMaximum
()
:
FunctionExpression
;
arrayMaximumN
(
n
:
number
|
Expression
)
:
FunctionExpression
;
arrayMinimum
()
:
FunctionExpression
;
arrayMinimumN
(
n
:
number
|
Expression
)
:
FunctionExpression
;
arraySlice
(
offset
:
number
|
Expression
,
length
?:
number
|
Expression
,
)
:
FunctionExpression
;
arrayTransform
(
elementAlias
:
string
,
transform
:
Expression
,
)
:
FunctionExpression
;
arrayTransformWithIndex
(
elementAlias
:
string
,
indexAlias
:
string
,
transform
:
Expression
,
)
:
FunctionExpression
;
as
(
name
:
string
)
:
AliasedExpression
;
ascending
()
:
Ordering
;
average
()
:
Accumulator
;
count
()
:
Accumulator
;
countDistinct
()
:
Accumulator
;
descending
()
:
Ordering
;
equal
(
expression
:
Expression
)
:
BooleanExpression
;
equal
(
value
:
unknown
)
:
BooleanExpression
;
first
()
:
Accumulator
;
greaterThan
(
expression
:
Expression
)
:
BooleanExpression
;
greaterThan
(
value
:
unknown
)
:
BooleanExpression
;
greaterThanOrEqual
(
expression
:
Expression
)
:
BooleanExpression
;
greaterThanOrEqual
(
value
:
unknown
)
:
BooleanExpression
;
last
()
:
Accumulator
;
maximum
()
:
Accumulator
;
minimum
()
:
Accumulator
;
sum
()
:
Accumulator
;
}
Hierarchy (
View Summary
)
Selectable
FluentExpressionMethods
VariableExpression
Index
Methods
add
array
Agg
array
Agg
Distinct
array
Filter
array
First
array
First
N
array
Index
Of
array
Index
Of
All
array
Last
array
Last
Index
Of
array
Last
N
array
Maximum
array
Maximum
N
array
Minimum
array
Minimum
N
array
Slice
array
Transform
array
Transform
With
Index
as
ascending
average
count
count
Distinct
descending
equal
first
greater
Than
greater
Than
Or
Equal
last
maximum
minimum
sum
Properties
_
brand?
selectable
Methods
add
add
(
value
:
Expression
)
:
FunctionExpression
Beta
Parameters
value
:
Expression
Returns
FunctionExpression
add
(
value
:
unknown
)
:
FunctionExpression
Beta
Parameters
value
:
unknown
Returns
FunctionExpression
array
Agg
arrayAgg
()
:
Accumulator
Beta
Returns
Accumulator
array
Agg
Distinct
arrayAggDistinct
()
:
Accumulator
Beta
Returns
Accumulator
array
Filter
arrayFilter
(
alias
:
string
,
filter
:
BooleanExpression
)
:
FunctionExpression
Beta
Parameters
alias
:
string
filter
:
BooleanExpression
Returns
FunctionExpression
array
First
arrayFirst
()
:
FunctionExpression
Beta
Returns
FunctionExpression
array
First
N
arrayFirstN
(
n
:
number
|
Expression
)
:
FunctionExpression
Beta
Parameters
n
:
number
|
Expression
Returns
FunctionExpression
array
Index
Of
arrayIndexOf
(
search
:
unknown
)
:
FunctionExpression
Beta
Parameters
search
:
unknown
Returns
FunctionExpression
array
Index
Of
All
arrayIndexOfAll
(
search
:
unknown
)
:
FunctionExpression
Beta
Parameters
search
:
unknown
Returns
FunctionExpression
array
Last
arrayLast
()
:
FunctionExpression
Beta
Returns
FunctionExpression
array
Last
Index
Of
arrayLastIndexOf
(
search
:
unknown
)
:
FunctionExpression
Beta
Parameters
search
:
unknown
Returns
FunctionExpression
array
Last
N
arrayLastN
(
n
:
number
|
Expression
)
:
FunctionExpression
Beta
Parameters
n
:
number
|
Expression
Returns
FunctionExpression
array
Maximum
arrayMaximum
()
:
FunctionExpression
Beta
Returns
FunctionExpression
array
Maximum
N
arrayMaximumN
(
n
:
number
|
Expression
)
:
FunctionExpression
Beta
Parameters
n
:
number
|
Expression
Returns
FunctionExpression
array
Minimum
arrayMinimum
()
:
FunctionExpression
Beta
Returns
FunctionExpression
array
Minimum
N
arrayMinimumN
(
n
:
number
|
Expression
)
:
FunctionExpression
Beta
Parameters
n
:
number
|
Expression
Returns
FunctionExpression
array
Slice
arraySlice
(
offset
:
number
|
Expression
,
length
?:
number
|
Expression
,
)
:
FunctionExpression
Beta
Parameters
offset
:
number
|
Expression
Optional
length
:
number
|
Expression
Returns
FunctionExpression
array
Transform
arrayTransform
(
elementAlias
:
string
,
transform
:
Expression
)
:
FunctionExpression
Beta
Parameters
elementAlias
:
string
transform
:
Expression
Returns
FunctionExpression
array
Transform
With
Index
arrayTransformWithIndex
(
elementAlias
:
string
,
indexAlias
:
string
,
transform
:
Expression
,
)
:
FunctionExpression
Beta
Parameters
elementAlias
:
string
indexAlias
:
string
transform
:
Expression
Returns
FunctionExpression
as
as
(
name
:
string
)
:
AliasedExpression
Beta
Parameters
name
:
string
Returns
AliasedExpression
ascending
ascending
()
:
Ordering
Beta
Returns
Ordering
average
average
()
:
Accumulator
Beta
Returns
Accumulator
count
count
()
:
Accumulator
Beta
Returns
Accumulator
count
Distinct
countDistinct
()
:
Accumulator
Beta
Returns
Accumulator
descending
descending
()
:
Ordering
Beta
Returns
Ordering
equal
equal
(
expression
:
Expression
)
:
BooleanExpression
Beta
Parameters
expression
:
Expression
Returns
BooleanExpression
equal
(
value
:
unknown
)
:
BooleanExpression
Beta
Parameters
value
:
unknown
Returns
BooleanExpression
first
first
()
:
Accumulator
Beta
Returns
Accumulator
greater
Than
greaterThan
(
expression
:
Expression
)
:
BooleanExpression
Beta
Parameters
expression
:
Expression
Returns
BooleanExpression
greaterThan
(
value
:
unknown
)
:
BooleanExpression
Beta
Parameters
value
:
unknown
Returns
BooleanExpression
greater
Than
Or
Equal
greaterThanOrEqual
(
expression
:
Expression
)
:
BooleanExpression
Beta
Parameters
expression
:
Expression
Returns
BooleanExpression
greaterThanOrEqual
(
value
:
unknown
)
:
BooleanExpression
Beta
Parameters
value
:
unknown
Returns
BooleanExpression
last
last
()
:
Accumulator
Beta
Returns
Accumulator
maximum
maximum
()
:
Accumulator
Beta
Returns
Accumulator
minimum
minimum
()
:
Accumulator
Beta
Returns
Accumulator
sum
sum
()
:
Accumulator
Beta
Returns
Accumulator
Properties
Optional
Readonly
Beta
_
brand
_brand
?:
"VariableExpression"
Beta
selectable
selectable
:
true
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Methods
add
array
Agg
array
Agg
Distinct
array
Filter
array
First
array
First
N
array
Index
Of
array
Index
Of
All
array
Last
array
Last
Index
Of
array
Last
N
array
Maximum
array
Maximum
N
array
Minimum
array
Minimum
N
array
Slice
array
Transform
array
Transform
With
Index
as
ascending
average
count
count
Distinct
descending
equal
first
greater
Than
greater
Than
Or
Equal
last
maximum
minimum
sum
Properties
_
brand
selectable
Documentation
Documentation
GitHub
npm
React Native Firebase
Loading...
Variable expression returned by
variable(...).