Oracle® Backend For Firebase JavaScript Namespace SDK Reference
Release 26.1.0
G48197-02

Class AggregateField

AggregateField - Represents the aggregation that needs to be applied.

Index

Constructors

Methods

isEqual average count sum

Constructors

constructor

new AggregateField(): AggregateField
Returns AggregateField

Methods

isEqual

isEqual(other: AggregateField): boolean
Checks whether this AggreagteField is equal to the provided one.
Parameters
- other: AggregateField
  AggregateField that needs to be compared.
Returns boolean
Returns true if both AggregateField instances are the same.

Throws
Throws an error if other is not an AggregateField instance.
- Defined in oracledb/collection/aggregate.d.ts:66

`Static`average

average(field: string | FieldPath): AggregateField
Creates a AggregateField instance for average operation.
Parameters
- field: string | FieldPath
  Field name to which operation needs to be applied.
Returns AggregateField
A new AggregateField instance.
- Defined in oracledb/collection/aggregate.d.ts:48

`Static`count

count(): AggregateField
Creates a AggregateField instance for count operation.

Returns AggregateField
A new AggregateField instance.
- Defined in oracledb/collection/aggregate.d.ts:55

`Static`sum

sum(field: string | FieldPath): AggregateField
Creates a AggregateField instance for sum operation.
Parameters
- field: string | FieldPath
  Field name to which operation needs to be applied.
Returns AggregateField
A new AggregateField instance.
- Defined in oracledb/collection/aggregate.d.ts:40