How does Query.prototype.getOptions() work in Mongoose?

Last Updated : 17 Mar, 2021

The Query.prototype.getOptions() function is used to get the query options. Using this function, all the options which are set for a query can be easily get.

Syntax:

Query.prototype.getOptions()

Parameters: This function has no parameter.
Return Value: This function returns Query Object.
Installing mongoose :

npm install mongoose

After installing the mongoose module, you can check your mongoose version in command prompt using the command.

npm mongoose --version

After that, you can just create a folder and add a file for example, index.js as shown below.

Database: The sample database used here is shown below:

Project Structure: The project structure will look like this:

Example 1:

index.js

const mongoose = require('mongoose');

// Database connection
mongoose.connect('mongodb://127.0.0.1:27017/geeksforgeeks', {
    useNewUrlParser: true,
    useCreateIndex: true,
    useUnifiedTopology: true
});

// User model
const User = mongoose.model('User', { 
    name: { type: String },
    age: { type: Number }
});

var query = User.find()
query.limit(10);
query.setOptions({ maxTimeMS: 1000 })

console.log("Options:",query.getOptions());

Run index.js file using below command:

node index.js

Output:

Options: { limit: 10, maxTimeMS: 1000 }

Example 2:
Filename: index.js

javascript

const express = require('express');
const mongoose = require('mongoose');
const app = express()

// Database connection
mongoose.connect('mongodb://127.0.0.1:27017/geeksforgeeks', {
    useNewUrlParser: true,
    useCreateIndex: true,
    useUnifiedTopology: true
});

// User model
const User = mongoose.model('User', { 
    name: { type: String },
    age: { type: Number }
});

var query = User.find()
query.limit(20);
query.setOptions({ maxTimeMS: 2570 })

console.log("Options:",query.getOptions());

app.listen(3000, function(error ) {
    if(error) console.log(error)
    console.log("Server listening on PORT 3000")
});

Run index.js file using below command:

node index.js

Output:

Server listening on PORT 3000
Options: { limit: 20, maxTimeMS: 2570 }

Reference:
https://mongoosejs.com/docs/api/query.html#query_Query-getOptions

NodeJS Introduction

gouravhammad

Improve

Article Tags :

How does Query.prototype.getOptions() work in Mongoose?

Similar Reads

Introduction & Installation

Node.js Modules , Buffer & Streams

Node.js Asynchronous Programming

Node.js NPM

Node.js Deployments & Communication

Resources & Tools

Thank You!

What kind of Experience do you want to share?