DOCSP-48893 Add get started with Mongoose tutorial #1138
Conversation
✅ Deploy Preview for docs-node ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Nice work overall! I think this page could benefit by being converted into a stepped tutorial page (as mentioned in a few of my comments). Right now it reads like a reference page but has a lot of callbacks to previous sections and relies on running through each section in order. This could be confusing to anyone treating this like a regular reference-style page. Happy to discuss more about this and brainstorm ways to go about it!
| exists() | ||
| ~~~~~~~~ | ||
|
|
||
| The ``exists()`` method returns either ``null`` or the ``ObjectId`` of a document that |
There was a problem hiding this comment.
Not strictly true, exists() returns either null or the first document that matches filter with the projection { _id: 1 } applied. So doesn't return an ObjectId, rather a POJO with an _id property.
Also, I may be wrong but it seems a bit strange to introduce exists() before find(). exists() is helpful primarily for performance reasons, most basic applications don't need to use it.
There was a problem hiding this comment.
Updated the exists() description and moved the whole Helper Methods section down to the Next Steps section.
| const blogFind = await Blog.findOne({ author: "Jess Garcia" }); | ||
| console.log(blogFind); | ||
|
|
||
| const blogWhere = await Blog.where("author").equals("Jess Garcia"); |
There was a problem hiding this comment.
It is slightly more idiomatic (but equivalent) to do Blog.find().where('author').equals('Jess Garcia').
However, similar to exists(), I recommend not introducing where() so early, and you may want to exclude it entirely. Mongoose's chaining syntax has waned in popularity in recent years.
There was a problem hiding this comment.
Updated the description to include general use cases.
|
|
||
| .. note:: | ||
|
|
||
| The Mongoose ``exec()`` function is an option of the ``findById()`` |
There was a problem hiding this comment.
exec isn't an option. I think this section should clarify that findById() returns a Mongoose query object, and exec() executes the query and returns a promise.
| set ``required`` to true on any fields that you want to require. You can | ||
| also validate the type and the formatting. In the preceding code, the | ||
| ``slug`` field is defined as a ``string`` that is always in ``lowercase``. | ||
| This validation takes the slug input and converts it to lowercase before |
There was a problem hiding this comment.
lowercase is implemented as a setter, not a validator. However, you also added a minLength property, which is a validator. You can update this paragraph to use minLength instead.
There was a problem hiding this comment.
Used minLength and added a custom setters section to the Next Steps section below.
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-48893
Original page - https://www.mongodb.com/developer/languages/javascript/getting-started-with-mongodb-and-mongoose/
Staging Links
Self-Review Checklist