feat(document): add schemaFieldsOnly option to toObject() and toJSON() #15259
+135
−18
Conversation
This file contains 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
hasezoey
approved these changes
Feb 14, 2025
Comment on lines
+219
to
+220
| /** If true, the resulting object will only have fields that are defined in the document's schema. By default, `toJSON()` returns all fields in the underlying document from MongoDB, including ones that are not listed in the schema. */ | ||
| schemaFieldsOnly?: boolean; |
There was a problem hiding this comment.
Suggested change
| /** If true, the resulting object will only have fields that are defined in the document's schema. By default, `toJSON()` returns all fields in the underlying document from MongoDB, including ones that are not listed in the schema. */ | |
| schemaFieldsOnly?: boolean; | |
| /** If true, the resulting object will only have fields that are defined in the document's schema. By default, `toJSON()` & `toObject()` returns all fields in the underlying document from MongoDB, including ones that are not listed in the schema. */ | |
| schemaFieldsOnly?: boolean; |
Comment on lines
+14309
to
+14310
| const type1Key = 'type1'; | ||
| const type2Key = 'type2'; |
There was a problem hiding this comment.
For consistency, this could also be used in the .discriminator calls
Comment on lines
+14327
to
+14328
| assert.strictEqual(doc2.field1, undefined); | ||
| assert.strictEqual(doc2.field2, 'test2'); |
There was a problem hiding this comment.
Suggested change
| assert.strictEqual(doc2.field1, undefined); | |
| assert.strictEqual(doc2.field2, 'test2'); | |
| assert.strictEqual(doc2.field2, 'test2'); | |
| assert.strictEqual(doc2.field1, undefined); |
Align with the style of the following 2 checks
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 #15218
Summary
toObject()andtoJSON()currently return an object with all fields from the document in the database, which may include fields that aren't in the schema. To work around that, we added aschemaFieldsOnlyoption totoObject()andtoJSON(), which will loop over schema paths when getting values vs just cloning the entirety of_doc.Examples