Mongoose Query.prototype.comment()用法及代碼示例

Query.prototype.comment() 用於指定注釋選項。可以在 $query 可能出現的任何上下文中為查詢附加注釋。語法：

Query.prototype.comment()

參數：該函數有一個數組參數，即字符串類型的注釋。
返回值：此函數返回查詢對象。
Installing mongoose:

npm install mongoose

安裝 mongoose 模塊後，您可以使用命令在命令提示符下檢查您的 mongoose 版本。

npm mongoose --version

現在，創建一個文件夾並添加一個文件，例如 index.js，如下所示。

範例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.comment('Query to find all documents')
  
console.log("Comment:", query.options)

運行程序的步驟：

項目結構將如下所示：

使用以下命令運行index.js文件：

node index.js

輸出：

Comment: { comment:'Query to find all documents' }

範例2：

index.js


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.comment('Find All')
  
console.log("Comment:", query.options);
  
app.listen(3000, function(error ) {
    if(error) console.log(error)
    console.log("Server listening on PORT 3000")
});

運行程序的步驟：

項目結構將如下所示：

使用以下命令運行index.js文件：

node index.js

輸出：

Server listening on PORT 3000
Comment: { comment:'Find All' }

參考： https://mongoosejs.com/docs/api/query.html#query_Query-comment

相關用法

注：本文由純淨天空篩選整理自gouravhammad大神的英文原創作品 How does Query.prototype.comment() work in Mongoose ?。非經特殊聲明，原始代碼版權歸原作者所有，本譯文未經允許或授權，請勿轉載或複製。