Return full type T from findOne() and cursor methods instead of Partial<T> #21
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
.findOne()and cursor methods were returningPartial<T>unconditionally, forcing consumers to handle potentially undefined fields even when no projection was used:Changes
Updated return types:
findOne():Promise<Partial<T> | null>→Promise<T | null>FindCursor.toArray():Promise<Partial<T>[]>→Promise<T[]>FindCursor.first():Promise<Partial<T> | null>→Promise<T | null>Added JSDoc remarks explaining that projected fields may be undefined at runtime despite the type being
T, accepting this trade-off for better ergonomics in the common caseBehavior with projections
When projections are used, fields are undefined at runtime but typed as
T:This matches MongoDB driver behavior and prioritizes the common non-projection case.
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.