Module "operators/pipeline/sort"

Index

Functions

Object literals

COLLATION_STRENGTH

Functions

$sort

$sort(collection: Iterator, sortKeys: Record<string, 1 | -1>, options?: Options): Iterator

- Defined in src/operators/pipeline/sort.ts:26
Takes all input documents and returns them in a stream of sorted documents.

Parameters
- collection: Iterator
- sortKeys: Record<string, 1 | -1>
- Optional options: Options
Returns Iterator

collationComparator

collationComparator(spec: CollationSpec): Comparator<AnyVal>

- Defined in src/operators/pipeline/sort.ts:102
Creates a comparator function for the given collation spec. See https://docs.mongodb.com/manual/reference/collation/

Parameters
- spec: CollationSpec
  
  The MongoDB collation spec. { locale: string, caseLevel: boolean, caseFirst: string, strength: int, numericOrdering: boolean, alternate: string, maxVariable: string, // unsupported backwards: boolean // unsupported }
Returns Comparator<AnyVal>

Object literals

Const COLLATION_STRENGTH

COLLATION_STRENGTH: object

1

1: string = "base"

2

2: string = "accent"

3

3: string = "variant"

Generated using TypeDoc