Mongoose Schema.prototype.plugin()用法及代码示例

Mongoose API 的 Mongoose Schema API .prototype.plugin() 方法用于 Schema 对象。它允许我们为模式创建插件。在插件的帮助下，我们可以对多个模式使用相同的逻辑。让我们通过一个例子来理解plugin()方法。

用法:

schemaObject.plugin( <callback_function>, <options> );

Parameters: 该方法接受两个参数，如下所述：

callback:它用于指定回调函数。
options: 它用于识别各种属性。

返回值：该方法不返回任何值。

设置 Node.js Mongoose 模块：

步骤 1：使用以下命令创建 Node.js 应用程序：

npm init

步骤 2：创建 NodeJS 应用程序后，使用以下命令安装所需的模块：

npm install mongoose

项目结构：项目结构将如下所示：

示例 1：下面的示例说明了 Mongoose Schema plugin() 方法的函数。我们正在访问模式对象上的 () 方法。

文件名：app.js

Javascript


// Require mongoose module 
const mongoose = require("mongoose"); 
  
// Set Up the Database connection 
const URI = "mongodb://localhost:27017/geeksforgeeks"
  
const connectionObject = mongoose.createConnection(URI, { 
    useNewUrlParser: true, 
    useUnifiedTopology: true, 
}); 
  
const customerSchema = new mongoose.Schema({ 
    name: String, 
    address: String, 
    orderNumber: Number, 
}); 
  
customerSchema.plugin((schema => {  
    console.log(schema.pathType('address')) })) 
  
const Customer = connectionObject 
    .model('Customer', customerSchema);

运行程序的步骤：要运行应用程序，请从项目的根目录执行以下命令：

node app.js

输出：

real

示例 2：下面的示例说明了 Mongoose Schema plugin() 方法的函数。我们正在访问模式对象上所需的 paths() 方法。此方法将返回架构级别所需的字段数组。

文件名：app.js

Javascript


// Require mongoose module 
const mongoose = require("mongoose"); 
  
// Set Up the Database connection 
const URI = "mongodb://localhost:27017/geeksforgeeks"
  
const connectionObject = mongoose.createConnection(URI, { 
    useNewUrlParser: true, 
    useUnifiedTopology: true, 
}); 
  
const studentSchema = new mongoose.Schema({ 
    name: { type: String, required: true }, 
    age: Number, 
    rollNumber: { type: Number, required: true } 
}); 
  
studentSchema.plugin((schemaObject => {  
    console.log(schemaObject.requiredPaths()) })) 
  
const StudentModel = connectionObject 
    .model('Student', studentSchema);

运行程序的步骤：要运行应用程序，请从项目的根目录执行以下命令：

node app.js

输出：

[ 'rollNumber', 'name' ]

参考：https://mongoosejs.com/docs/api/schema.html#schema_Schema-plugin

相关用法

注：本文由纯净天空筛选整理自sakshio0hoj大神的英文原创作品 Mongoose Schema.prototype.plugin() API。非经特殊声明，原始代码版权归原作者所有，本译文未经允许或授权，请勿转载或复制。