Mongoose Query.prototype.limit() API

The Mongoose Query API limit() method is used to limit the number of documents returned from the query API to the specified count.

Syntax:

Query.prototype.limit(val)

Parameters: It accepts a single parameter as described below:

• val: It is a number that determines the maximum number of documents the query API will return.

Return type: It returns a Query 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 almost 1 document that has an age greater than “18”.

Filename: main.js

Javascript

const mongoose = require('mongoose')

// Database connection
mongoose.connect('mongodb://localhost:27017/query-helpers',
    {
        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: 19
    },
    {
        name: 'Nami',
        age: 20,
    },
    {
        name: 'Zoro',
        age: 35
    }
]

const Person = mongoose.model('Person', personSchema);

(async () => {
    await Person.insertMany(personsArray);
    const res = await Person.where(
        { age: { $gt: 18 } }
    ).limit(1);
    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:

GUI Representation of the  Database using MongoDB Compass:

Example 2: In this example, we will use this method to return all documents that have an age greater than “18”.

Filename: main.js

Javascript

const mongoose = require('mongoose')

// Database connection
mongoose.connect('mongodb://localhost:27017/query-helpers',
    {
        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: 19
    },
    {
        name: 'Nami',
        age: 20,
    },
    {
        name: 'Zoro',
        age: 35
    }
]

const Person = mongoose.model('Person', personSchema);

(async () => {
    await Person.insertMany(personsArray);
    const res = await Person.where(
        { age: { $gt: 18 } }
    ).limit();
    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:

GUI Representation of the  Database using MongoDB Compass:

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