Merge pull request #11885 from ghost91-/make-sort-arg-optional

make arg of Query.sort optional in the type definitions
Automattic · Jun 2, 2022 · ebab664 · ebab664
2 parents 6cdbd89 + abd3f3e
commit ebab664
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/test/types/queries.test.ts b/test/types/queries.test.ts
@@ -137,6 +137,15 @@ const p1: Record<string, number> = Test.find().projection('age docs.id');
 const p2: Record<string, number> | null = Test.find().projection();
 const p3: null = Test.find().projection(null);
 
+// Sorting
+Test.find().sort();
+Test.find().sort('-name');
+Test.find().sort({ name: -1 });
+Test.find().sort({ name: 'ascending' });
+Test.find().sort(undefined);
+Test.find().sort(null);
+expectError(Test.find().sort({ name: 2 }));
+expectError(Test.find().sort({ name: 'invalidSortOrder' }));
 
 // Super generic query
 function testGenericQuery(): void {

diff --git a/types/query.d.ts b/types/query.d.ts
@@ -579,7 +579,7 @@ declare module 'mongoose' {
     snapshot(val?: boolean): this;
 
     /** Sets the sort order. If an object is passed, values allowed are `asc`, `desc`, `ascending`, `descending`, `1`, and `-1`. */
-    sort(arg: string | { [key: string]: SortOrder }): this;
+    sort(arg?: string | { [key: string]: SortOrder } | undefined | null): this;
 
     /** Sets the tailable option (for use with capped collections). */
     tailable(bool?: boolean, opts?: {