BREAKING CHANGE: remove skipId parameter to Document() and Model(), always use as options #15656
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…lways use as options Fix #8862
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR removes the deprecated skipId parameter from the Document() and Model() constructors, requiring the use of an options object instead. This is a breaking change that simplifies the API by eliminating parameter overloading where the third parameter could be either a boolean or an options object.
- Removes support for passing
skipIdas a boolean third parameter to constructors - Updates all internal code to use
{ skipId: true }in options object instead - Adds error handling to prevent accidental usage of the old boolean parameter
Reviewed Changes
Copilot reviewed 10 out of 11 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| lib/document.js | Core constructor changes to only accept options object and throw error for boolean usage |
| lib/model.js | Updates Model constructor signature and documentation |
| lib/types/subdocument.js | Removes skipId parameter handling logic |
| lib/types/arraySubdocument.js | Updates Subdocument constructor call |
| lib/schema/subdocument.js | Updates constructor calls to use options object |
| lib/queryHelpers.js | Updates discriminator instantiation |
| lib/query.js | Updates model instantiation for replaceOne |
| lib/helpers/model/castBulkWrite.js | Updates model instantiation for bulk operations |
| test/document.test.js | Formatting change to test constructor call |
| docs/migrating_to_9.md | Adds migration documentation |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
hasezoey
approved these changes
Oct 2, 2025
Co-authored-by: Copilot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fix #8862
Summary
The
skipIdparameter was taking up some prime real estate as the 3rd arg tonew MyModel(), replace that withoptions. We already supported passingoptions, this PR just drops support for passing a boolean as 3rd arg tonew MyModel().Examples