Back to Firebase Js Sdk

Ordering class

docs-devsite/firestore_lite_pipelines.ordering.md

12.12.11.8 KB
Original Source

Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

Ordering class

Represents an ordering criterion for sorting documents in a Firestore pipeline.

You create Ordering instances using the ascending and descending helper functions.

<b>Signature:</b>

typescript
export declare class Ordering 

Constructors

ConstructorModifiersDescription
(constructor)(expr, direction, _methodName)Constructs a new instance of the <code>Ordering</code> class

Properties

PropertyModifiersTypeDescription
direction'ascending' | 'descending'
exprExpression

Ordering.(constructor)

Constructs a new instance of the Ordering class

<b>Signature:</b>

typescript
constructor(expr: Expression, direction: 'ascending' | 'descending', _methodName: string | undefined);

Parameters

ParameterTypeDescription
exprExpression
direction'ascending' | 'descending'
_methodNamestring | undefined

Ordering.direction

<b>Signature:</b>

typescript
readonly direction: 'ascending' | 'descending';

Ordering.expr

<b>Signature:</b>

typescript
readonly expr: Expression;