Как написать и протестировать универсальные модули JavaScript (браузер, Node.js)

1. Написание универсального модуля

1.1. Модули Node.js

Модуль Node.js выглядит следующим образом:

    var privateVariable = 123;
    function privateFunction() {
    }
    
    exports.publicVariable = 345;
    exports.publicFunction = function () {
        return privateVariable * exports.publicVariable;
    }

Вы добавляете свои общедоступные данные в экспорт объектов, которым управляет Node.js. Кроме того, Node.js гарантирует, что все остальные данные остаются конфиденциальными для вашего модуля. Внутри модуля вы обращаетесь непосредственно к частным данным, к открытым данным через экспорт. Ниже показано, как используется такой модуль.

1.2. Делаем код Node.js универсальным

Вы можете использовать код модуля Node.js в браузерах, если обернуть его следующим образом:

    "use strict";

    (function(exports) {
        
        // Your Node.js code goes here

    }(typeof exports === "undefined" ? (this.moduleName = {}) : exports));

Давайте рассмотрим код оболочки:

• Включение строгого режима: первая строка включает строгий режим [1] в ECMAScript 5 и ничего не делает в старых версиях JavaScript.
• Немедленно вызванное определение функции (IIFE): мы определяем функцию и немедленно ее вызываем [2]. Это служит двум целям:
  
  • Неэкспортированные данные остаются закрытыми в браузерах, где Node.js не делает этого за нас.
  • Он условно создает переменную export, которая существует в Node.js, но должна быть создана в браузере. Создание новой области с новой переменной экспорта является единственным способом сделать это, вы не можете добавить переменную в существующую область, если ее еще нет. То есть вы не можете делать следующее:

        if (typeof exports !== "undefined") {
            var exports = {}; // (*)
        }
    

    Причина: объявление (но не присвоение!) В (*) переносится в начало текущей функции, что означает, что экспорт всегда будет неопределенным при выполнении проверки. Обратите внимание, что это будет работать без подъёма, но не с масштабированием блока, потому что тогда экспорт, объявленный в (*), будет существовать только внутри блока then.

• typeof exports === «undefined»: существует ли переменный экспорт?
• this.moduleName = {}: На глобальном уровне это относится к глобальному объекту. Следовательно, это назначение создает глобальную переменную moduleName (имя модуля в браузере).

Бегущий пример:

    "use strict";

    (function(exports) {

        exports.StringSet = function () {
            this.data = {};
        }

        exports.StringSet.prototype.add = function(elem) {
            if (typeof elem !== "string") {
                throw new TypeError("Argument is not a string: "+elem);
            }
            this.data[elem] = true;
        }

        exports.StringSet.prototype.contains = function(elem) {
            // Comparison ensures boolean result
            return this.data[elem] === true;
        }
        
        exports.StringSet.prototype.copy = function() {
            var result = new exports.StringSet();
            Object.keys(this.data).forEach(function(elem) {
                result.add(elem);
            });
            return result;
        }

    }(typeof exports === "undefined" ? (this.strset = {}) : exports));

2. Использование универсального модуля

Узел:

    var strset = require("./strset");
    var s = new strset.StringSet();

Браузер:

    <script src="strset.js"></script>
    <script>
        var s = new strset.StringSet();
    </script>

3. Юнит-тестирование универсального модуля

3.1. Node.js: юнит-тестирование через модуль assert