Шаблон одноэлементного модуля Node.js, требующий внешних входных данных

Похоже, вы пытаетесь создать модуль, который инициализируется в одном месте, а затем использует некоторый общий ресурс из этой инициализации для других пользователей этого модуля. Это полураспространенная потребность в реальном мире.

Во-первых, идеально, если модуль может загружать или создавать вещи, от которых он зависит, потому что это делает его более модульным и полезным сам по себе и снижает нагрузку на тех, кто его использует. Итак, в вашем случае, если бы ваш модуль мог просто создать/загрузить то, что ему нужно, при первом создании модуля и просто сохранить этот ресурс в своей собственной переменной модуля, то это был бы идеальный случай. Но это не всегда возможно, потому что за общий ресурс может отвечать кто-то другой за настройку и инициализацию, и этот модуль просто должен знать об этом.

Итак, распространенный способ сделать это — просто использовать функцию-конструктор для модуля. В Javascript вы можете разрешить конструктору принимать необязательный аргумент, предоставляющий информацию об инициализации. Код, отвечающий за настройку модуля, вызовет конструктор с нужным параметром настройки. Другие пользователи модуля, которые не отвечали за настройку модуля, могли либо просто не вызывать конструктор, либо, если им нужно возвращаемое значение, или есть другие параметры конструктора, которые они должны передать, они могут передать null для этого параметра настройки.

Например, вы можете сделать это:

var io;

module.exports = function(setup_io) {
    if (setup_io) {
        io = setup_io;
    }
    return module.exports;
};

module.exports.method1 = function() {
    if (!io) {
        throw new Error("Can't use method1 until io is properly initalized");
    }
    // code here for method1
};

// other methods here

Затем пользователи модуля могут сделать это:

// load myModule and initialize it with a shared variable
var myModule = require('myModule')(io);

или это:

// load myModule without initializing it 
// (assume some other module will initialize it properly)
var myModule = require('myModule');

Примечание. Для здравомыслия разработчика было бы полезно иметь отдельные методы, требующие соответствующей настройки (прежде чем их можно будет использовать должным образом), чтобы проверить, был ли настроен модуль, когда вызывается какой-либо метод, который нуждается в этой настройке, чтобы правильно информировать разработчик, который вызвал метод перед правильной настройкой модуля. В противном случае ошибки могут возникать гораздо дальше по течению и, вероятно, не будут иметь полезных сообщений об ошибках.

Если теперь вы хотите, чтобы процесс инициализации был асинхронным, это тоже можно сделать, но это, безусловно, усложняет другие виды использования модуля, поскольку они не обязательно будут знать, когда и был ли модуль инициализирован.

var moduleData;
var readyList = new EventEmitter();

module.exports = function(arg, callback) {
    // do some async operation here involving arg
    // when that operation completes, you stored the result
    // in local module data and call the callback
    readyList.on("ready", callback);
    someAsyncOperation(arg, function() {
        // set moduleData here
        // notify everyone else that the module is now ready
        readyList.emit("ready");
        // remove all listeners since this is a one-shot event
        readyList.removeAllListeners("ready");
    });
    return module.exports;
};

Если у вас есть другие пользователи этого модуля, которые хотят получать уведомления о завершении его инициализации, вы можете разрешить им самим зарегистрировать обратный вызов, чтобы получать уведомления о готовности модуля.

// pass a callback to this method that will be called
// async when the module is ready
module.exports.ready = function(fn) {
    // if module already ready, then schedule the callback immediately
    if (moduleData) {
        setImmediate(fn);
    } else {
        readyList.on("ready", fn);
    }
};

Если по причинам, которые я не совсем понимаю, вы хотите использовать один и тот же конструктор как для инициализации, так и для обнаружения готовности, это можно сделать, хотя я не думаю, что это так же очевидно, как просто использовать отдельный метод для обнаружения готовности:

var moduleData;
var readyList = new EventEmitter();

module.exports = function(arg, callback) {
    // if both arguments passed, assume this is a request for module
    // initialization
    if (arguments.length === 2) {
        // do some async operation here involving arg
        // when that operation completes, you stored the result
        // in local module data and call the callback
        readyList.on("ready", callback);
        someAsyncOperation(arg, function() {
            // set moduleData here
            // notify everyone else that the module is now ready
            readyList.emit("ready");
            // remove all listeners since this is a one-shot event
            readyList.removeAllListeners("ready");
        });
    } else {
        // constructor called just for a ready request
        // arg is the callback
        if (moduleData) {
            // if module already ready, then schedule the callback immediately
            setImmediate(arg);
        } else {
            // otherwise, save the callback
            readyList.on("ready", arg);
        }
    }
    return module.exports;
};

Использование для асинхронной инициализации модуля:

// async initialization form
var myModule = require("myModule")(someArg, function() {
    // can use myModule here
});

Использование для загрузки модуля и получения уведомлений, когда кто-то еще его инициализировал:

var myModule = require("myModule")(function() {
    // can use myModule here
});