Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

types: Fixes and improves Query.projection method signature #11210

Merged
merged 4 commits into from
Jan 20, 2022
+17 −2
Merged

types: Fixes and improves Query.projection method signature #11210

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b035a33
types: Fixes `Query.projection` method types
EugeneKorshenko Jan 10, 2022
35286d3
Add tests
EugeneKorshenko Jan 10, 2022
63ba06b
types: Weakening of type strictness for ProjectionFields
EugeneKorshenko Jan 16, 2022
ce550cc
Merge branch '6.2' into fix/types/projection
vkarpov15 Jan 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2117,6 +2117,8 @@ declare module 'mongoose' {

type UnpackedIntersection<T, U> = T extends (infer V)[] ? (V & U)[] : T & U;

type ProjectionFields<DocType> = {[Key in keyof Omit<LeanDocument<DocType>, '__v'>]?: number} & Record<string, number>;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't like restricting projections to numbers. There are plenty of codebases out there that use true/false instead of 0/1. And MongoDB does also allow using strings in select(), although that has different behavior than using true/false or 0/1.

Ideally I'd say this should be [Key in keyof Omit<LeanDocument<DocType>, '__v'>]?: any, but if you want to be more strict than that, we need to support:

  1. Boolean
  2. String
  3. Projection operators

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your review. I'll follow your version with any.


class Query<ResultType, DocType, THelpers = {}, RawDocType = DocType> {
_mongooseOptions: MongooseQueryOptions;

Expand Down Expand Up @@ -2403,7 +2405,9 @@ declare module 'mongoose' {
populate<Paths = {}>(options: PopulateOptions | Array<PopulateOptions>): QueryWithHelpers<UnpackedIntersection<ResultType, Paths>, DocType, THelpers, RawDocType>;

/** Get/set the current projection (AKA fields). Pass `null` to remove the current projection. */
projection(fields?: any | null): this;
projection(): ProjectionFields<DocType> | null;
projection(fields: null): null;
projection(fields?: ProjectionFields<DocType> | string): ProjectionFields<DocType>;

/** Determines the MongoDB nodes from which to read. */
read(pref: string | mongodb.ReadPreferenceMode, tags?: any[]): this;
Expand Down
13 changes: 12 additions & 1 deletion test/typescript/queries.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,17 @@ query instanceof Query;
Test.findOne().where({ name: 'test' });
Test.where().find({ name: 'test' });

// Projection
const p0: Record<string, number> = Test.find().projection({
age: 1,
parent: 1,
'docs.id': 1
});
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);


// Super generic query
function testGenericQuery(): void {
interface CommonInterface<T> extends Document {
Expand Down Expand Up @@ -184,4 +195,4 @@ function gh10786() {
if (true) {
updateQuery.phone = 'XXXX';
}
}
}