The Mongoose Query API getOptions() method is used to return the query options which are applied to the mongoose query system.
Syntax:
Query.prototype.getOptions()
Return type: It returns a JSON object as a response.
Creating node application And Installing Mongoose:
Step 1: Create a node application using the following command:
mkdir folder_name cd folder_name npm init -y touch main.js
Step 2: After completing the Node.js application, Install the required module using the following command:
npm install mongoose
Example 1: In this example, we will use this method to return the query options applied to the mongoose query.
Filename: main.js
// Importing the module const mongoose = require( 'mongoose' )
// Creating the connection {
dbName: 'event_db' ,
useNewUrlParser: true ,
useUnifiedTopology: true
}, err => err ? console.log(err)
: console.log( 'Connected to database' ));
const personSchema = new mongoose.Schema({
name: {
type: String,
},
age: {
type: Number,
}
}); const personsArray = [ {
name: 'Luffy' ,
age: 20
},
{
name: 'Nami' ,
age: 20,
},
{
name: 'Zoro' ,
age: 35
}
] const Person = mongoose.model( 'Person' , personSchema);
(async () => { const res = await Person
.find({ age: 20 })
.limit(10)
.getOptions();
console.log({ res });
})() |
Step to Run Application: Run the application using the following command from the root directory of the project:
node main.js
Output:
Example 2: In this example, we will use this method to return the query options applied to the mongoose query.
Filename: main.js
// Importing the module const mongoose = require( 'mongoose' )
// Creating the connection {
dbName: 'event_db' ,
useNewUrlParser: true ,
useUnifiedTopology: true
}, err => err ? console.log(err)
: console.log( 'Connected to database' ));
const personSchema = new mongoose.Schema({
name: {
type: String,
},
age: {
type: Number,
}
}); const personsArray = [ {
name: 'Luffy' ,
age: 20
},
{
name: 'Nami' ,
age: 20,
},
{
name: 'Zoro' ,
age: 35
}
] const Person = mongoose.model( 'Person' , personSchema);
(async () => { const res = await Person
.find({ age: 20 })
.setOptions({ counter: 100 })
.getOptions();
console.log({ res });
})() |
Step to Run Application: Run the application using the following command from the root directory of the project:
node main.js
Output:
Reference: https://mongoosejs.com/docs/api/query.html#query_Query-getOptions