Skip to content

Commit

Permalink
chore: fix some broken link paths
Browse files Browse the repository at this point in the history
  • Loading branch information
hasezoey committed Feb 5, 2023
1 parent 212ede1 commit ef5ad37
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions lib/aggregate.js
Original file line number Diff line number Diff line change
Expand Up @@ -876,8 +876,8 @@ Aggregate.prototype.session = function(session) {
* @param {Object} options keys to merge into current options
* @param {Number} [options.maxTimeMS] number limits the time this aggregation will run, see [MongoDB docs on `maxTimeMS`](https://www.mongodb.com/docs/manual/reference/operator/meta/maxTimeMS/)
* @param {Boolean} [options.allowDiskUse] boolean if true, the MongoDB server will use the hard drive to store data during this aggregation
* @param {Object} [options.collation] object see [`Aggregate.prototype.collation()`](./docs/api/aggregate.html#aggregate_Aggregate-collation)
* @param {ClientSession} [options.session] ClientSession see [`Aggregate.prototype.session()`](./docs/api/aggregate.html#aggregate_Aggregate-session)
* @param {Object} [options.collation] object see [`Aggregate.prototype.collation()`](#aggregate_Aggregate-collation)
* @param {ClientSession} [options.session] ClientSession see [`Aggregate.prototype.session()`](#aggregate_Aggregate-session)
* @see mongodb https://www.mongodb.com/docs/manual/reference/command/aggregate/
* @return {Aggregate} this
* @api public
Expand Down
8 changes: 4 additions & 4 deletions lib/model.js
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,8 @@ const saveToObjectOptions = Object.assign({}, internalToObjectOptions, {
*
* In Mongoose, the term "Model" refers to subclasses of the `mongoose.Model`
* class. You should not use the `mongoose.Model` class directly. The
* [`mongoose.model()`](/docs/mongoose.html#mongoose_Mongoose-model) and
* [`connection.model()`](/docs/connection.html#connection_Connection-model) functions
* [`mongoose.model()`](/docs/api/mongoose.html#mongoose_Mongoose-model) and
* [`connection.model()`](/docs/api/connection.html#connection_Connection-model) functions
* create subclasses of `mongoose.Model` as shown below.
*
* #### Example:
Expand All @@ -103,7 +103,7 @@ const saveToObjectOptions = Object.assign({}, internalToObjectOptions, {
* const userFromDb = await UserModel.findOne({ name: 'Foo' });
*
* @param {Object} doc values for initial set
* @param {Object} [fields] optional object containing the fields that were selected in the query which returned this document. You do **not** need to set this parameter to ensure Mongoose handles your [query projection](/docs/query.html#query_Query-select).
* @param {Object} [fields] optional object containing the fields that were selected in the query which returned this document. You do **not** need to set this parameter to ensure Mongoose handles your [query projection](/docs/api/query.html#query_Query-select).
* @param {Boolean} [skipId=false] optional boolean. If true, mongoose doesn't add an `_id` field to the document.
* @inherits Document https://mongoosejs.com/docs/api/document.html
* @event `error`: If listening to this event, 'error' is emitted when a document was saved without passing a callback and an `error` occurred. If not listening, the event bubbles to the connection used to create this Model.
Expand Down Expand Up @@ -485,7 +485,7 @@ function generateVersionError(doc, modifiedPaths) {
* @param {Boolean} [options.j] set to true for MongoDB to wait until this `save()` has been [journaled before resolving the returned promise](https://www.mongodb.com/docs/manual/reference/write-concern/#j-option). Overrides the [schema-level `writeConcern` option](/docs/guide.html#writeConcern)
* @param {Number} [options.wtimeout] sets a [timeout for the write concern](https://www.mongodb.com/docs/manual/reference/write-concern/#wtimeout). Overrides the [schema-level `writeConcern` option](/docs/guide.html#writeConcern).
* @param {Boolean} [options.checkKeys=true] the MongoDB driver prevents you from saving keys that start with '$' or contain '.' by default. Set this option to `false` to skip that check. See [restrictions on field names](https://www.mongodb.com/docs/manual/reference/limits/#Restrictions-on-Field-Names)
* @param {Boolean} [options.timestamps=true] if `false` and [timestamps](./guide.html#timestamps) are enabled, skip timestamps for this `save()`.
* @param {Boolean} [options.timestamps=true] if `false` and [timestamps](/docs/guide.html#timestamps) are enabled, skip timestamps for this `save()`.
* @param {Function} [fn] optional callback
* @throws {DocumentNotFoundError} if this [save updates an existing document](/docs/api/document.html#document_Document-isNew) but the document doesn't exist in the database. For example, you will get this error if the document is [deleted between when you retrieved the document and when you saved it](documents.html#updating).
* @return {Promise|undefined} Returns undefined if used with callback or a Promise otherwise.
Expand Down
10 changes: 5 additions & 5 deletions lib/query.js
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ const queryOptionMethods = new Set([
/**
* Query constructor used for building queries. You do not need
* to instantiate a `Query` directly. Instead use Model functions like
* [`Model.find()`](/docs/api/find.html#find_find).
* [`Model.find()`](/docs/api/model.html#model_Model-find).
*
* #### Example:
*
Expand Down Expand Up @@ -1088,7 +1088,7 @@ Query.prototype.projection = function(arg) {
* @instance
* @param {Object|String|String[]} arg
* @return {Query} this
* @see SchemaType /docs/api/schematype
* @see SchemaType /docs/api/schematype.html
* @api public
*/

Expand Down Expand Up @@ -3019,7 +3019,7 @@ Query.prototype.sort = function(arg) {
*
* #### Note:
*
* Calling `remove()` creates a [Mongoose query](./queries.html), and a query
* Calling `remove()` creates a [Mongoose query](/docs/queries.html), and a query
* does not execute until you either pass a callback, call [`Query#then()`](#query_Query-then),
* or call [`Query#exec()`](#query_Query-exec).
*
Expand Down Expand Up @@ -5192,7 +5192,7 @@ function castQuery(query) {
* @param {Object|Function} [options.match=null] Add an additional filter to the populate query. Can be a filter object containing [MongoDB query syntax](https://www.mongodb.com/docs/manual/tutorial/query-documents/), or a function that returns a filter object.
* @param {Function} [options.transform=null] Function that Mongoose will call on every populated document that allows you to transform the populated document.
* @param {Object} [options.options=null] Additional options like `limit` and `lean`.
* @see population /docs/populate
* @see population /docs/populate.html
* @see Query#select #query_Query-select
* @see Model.populate #model_Model-populate
* @return {Query} this
Expand Down Expand Up @@ -5463,7 +5463,7 @@ Query.prototype._applyPaths = function applyPaths() {
*
* @return {QueryCursor}
* @param {Object} [options]
* @see QueryCursor /docs/api/querycursor
* @see QueryCursor /docs/api/querycursor.html
* @api public
*/

Expand Down
2 changes: 1 addition & 1 deletion lib/virtualtype.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ const utils = require('./utils');
* @param {String|Function} [options.foreignField] the foreign field to populate on if this is a populated virtual.
* @param {Boolean} [options.justOne=false] by default, a populated virtual is an array. If you set `justOne`, the populated virtual will be a single doc or `null`.
* @param {Boolean} [options.getters=false] if you set this to `true`, Mongoose will call any custom getters you defined on this virtual
* @param {Boolean} [options.count=false] if you set this to `true`, `populate()` will set this virtual to the number of populated documents, as opposed to the documents themselves, using [`Query#countDocuments()`](./api/query.html#query_Query-countDocuments)
* @param {Boolean} [options.count=false] if you set this to `true`, `populate()` will set this virtual to the number of populated documents, as opposed to the documents themselves, using [`Query#countDocuments()`](/docs/api/query.html#query_Query-countDocuments)
* @param {Object|Function} [options.match=null] add an extra match condition to `populate()`
* @param {Number} [options.limit=null] add a default `limit` to the `populate()` query
* @param {Number} [options.skip=null] add a default `skip` to the `populate()` query
Expand Down

0 comments on commit ef5ad37

Please sign in to comment.