This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Represents an ordering criterion for sorting documents in a Firestore pipeline.
You create Ordering instances using the ascending and descending helper functions.
Signature:
export declare class Ordering
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(expr, direction, _methodName) | (Public Preview) Constructs a new instance of the Ordering class |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| direction | 'ascending' | 'descending' | (Public Preview) | |
| expr | Expression | (Public Preview) |
Ordering.(constructor)
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Constructs a new instance of the Ordering class
Signature:
constructor(expr: Expression, direction: 'ascending' | 'descending', _methodName: string | undefined);
Parameters
| Parameter | Type | Description |
|---|---|---|
| expr | Expression | |
| direction | 'ascending' | 'descending' | |
| _methodName | string | undefined |
Ordering.direction
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Signature:
readonly direction: 'ascending' | 'descending';
Ordering.expr
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Signature:
readonly expr: Expression;