Question

我正在开发一个具有多个功能的node.js模块模块本身将需要一些配置启动（将有默认值...可以被覆盖 - 例如文件路径）

导出功能时首选方法是什么？允许它从require语句实例化，并将配置对象（可选）传递给构造函数？

var MyModule = require('myModule);

var myModule = new MyModule({
    name: "test name"
});

myModule.doThing(function(x){

});

在模块中有这个：

module.exports = function MyModule(){
        MyModule.prototype.config = {name: "default name"}

            function doThing(cb){
                //do stuff
                cb();
            }
}

或者，从模块中的exports语句创建一个实例，然后像这样使用它：

var myModule = require('myModule);

myModule.config = {name: "test name"}

myModule.doThing(function(x){

});

相反，在模块中有这个：

module.exports = exports = MyModule();

function MyModule(){
MyModule.prototype.config = {name: "default name"}

    function doThing(cb){
        //do stuff
        cb();
    }
}

Answer 1

我会说让用户在实例化时提供一个对象，将默认值放在原型中。您可能还需要提供配置功能，这允许您（现在或将来）验证密钥/值，并允许您的用户在实例化后设置配置。

// Module

var Mod = module.exports = function Mod (opts) {
  opts = (opts === Object(opts)) ? opts :  {};

  // This allows users to instanciate without the `new` keyword
  if (! (this instanceof Mod)) {
    return new Mod(opts);
  }

  // Copy user provided configs to this.config
  for (var key in opts) if ({}.hasOwnProperty.call(opts, key)) {
    this.config[key] = opts[key];
  }
};

Mod.prototype.config = {
  foo : 'foo',
  bar : 'bar'
};

Mod.prototype.configure = function configure (key, val) {
  this.config[key] = val;
  return this;
};

// Usage

const Mod = require('/path/to/mod');

var i1 = new Mod;

var i2 = Mod();

var i3 = new Mod({
  foo: 'bar'
});

var i4 = Mod({
  foo: 'bar'
});

i4.configure('bar', 'baz');

var i5 = (new Mod).configure('bar', 'baz');

修改

正如Jake Sellers在评论中指出的那样，这不是CommonJS模块中的标准API模式。更好的解决方案是导出一个函数，该函数返回您正在创建的任何对象。

更重要的是，我不应该建议将配置放在原型中。这样做会使所有子项共享配置对象。因此，对它的任何修改也会影响所有儿童。对我感到羞耻，当我写这个废话时，我不是初学者。双重感谢杰克;）

更好的实施：

// Keep defaults private var defaults = { foo : 'foo', bar : 'bar' }; // Construct var Mod = function Mod (opts) { opts = (opts === Object(opts)) ? opts : {}; // This allows users to instanciate without the `new` keyword if (! (this instanceof Mod)) { return new Mod(opts); } this.config = {}; // Copy user provided configs to this.config or set to default for (var key in defaults) if (defaults.hasOwnProperty(key)) { if ({}.hasOwnProperty.call(opts, key)) { this.config[key] = opts[key]; } else { this.config[key] = defaults[key]; } } }; // Let the user update configuration post-instanciation Mod.prototype.configure = function configure (key, val) { this.config[key] = val; return this; }; // Export a function that creates the object exports.createMod = function createMod (opts) { return new Mod(opts); }; // Export the constructor so user is able to derive from it // or check instanceof exports.Mod = Mod; // USAGE var mod = require('/path/to/mod'); var i1 = mod.createMod({ foo : 'bar' }); i1.configure('bar', 'baz');

Answer 2

这取决于您是否希望模块的用户能够使用一个预定义的实例（您在module.exports上创建的实例），或者您是否希望他们能够创建自己的实例（然后你需要将构造函数导出为函数，而不是它的返回值）。

如果你去写一个构造函数，我会选择第二个选项（让用户创建实例） - 除非它是你提供的单个对象。

带有config的NodeJS模块 - 从require或from module.exports实例化

2 个答案: