Module Pattern — Encapsulated Code in JavaScript

In this tutorial, you'll learn how the Module Pattern uses closures to encapsulate private state and expose a public API.

What You'll Learn

how the Module Pattern uses closures to encapsulate private state and expose a public API.

Why It Matters

Global scope pollution breaks large JS apps. Modules isolate code and prevent naming conflicts.

Real-World Use

IIFE-based modules before ES modules, jQuery plugins, and Revealing Module pattern.

The Module Pattern Pattern

The Module Pattern pattern addresses a specific recurring design problem by providing a reusable solution structure. Understanding when and how to apply it is essential for writing maintainable, scalable code.

Key Concepts

• Abstraction: Module Pattern provides clean separation between interface and implementation.
• Reusability: Pattern can be applied across different contexts.
• Maintainability: Code organized with Module Pattern is easier to understand.
• Testability: Components can be tested in isolation.

Structure

The following diagram shows the structure of this pattern:

classDiagram
    class ModulePattern {
        +operation()
    }
    class Implementation {
        +execute()
    }
    ModulePattern --> Implementation

Implementation

// Module Pattern - JavaScript Module Pattern
const ModulePattern = (function() {
    let _counter = 0;
    const _items = new Map();

    function _validate(key) {
        return typeof key === 'string' && key.length > 0;
    }

    return {
        add(key, value) {
            if (_validate(key)) {
                _items.set(key, value);
                _counter++;
                return true;
            }
            return false;
        },
        get(key) {
            return _items.get(key);
        },
        count() {
            return _counter;
        },
        clear() {
            _items.clear();
            _counter = 0;
        }
    };
})();

console.log(ModulePattern.add('name', 'Alice'));
console.log(ModulePattern.add('', 'bad'));
console.log(ModulePattern.get('name'));
console.log(ModulePattern.count());
ModulePattern.clear();
console.log(ModulePattern.count());

Expected output:

true
false
Alice
1
0

Key Participants

• Client: Code that uses the Module Pattern.
• Module Pattern: The main abstraction provided by the pattern.
• Implementation: Concrete realization of the pattern.
• Data/State: Information managed by the pattern.

Real-World Examples

• DodaTech uses this pattern internally for consistent cross-cutting concerns.
• Major frameworks and libraries implement this pattern as a core architectural element.
• Production systems at scale depend on this pattern for reliability.

Related Patterns

• Revealing Module

• Iife

• Namespace Pattern

• Design Patterns — the complete patterns catalog.

Pros and Cons

Common Mistakes

1. **Over-engineering: Applying Module Pattern where a simpler solution suffices, adding unnecessary complexity.

2. **Wrong granularity: Implementing Module Pattern at the wrong level of abstraction.

3. **Thread Safety ignored: Using Module Pattern in concurrent context without proper synchronization.

4. **Tight coupling: Violating the pattern intent by creating hidden dependencies.

5. **Premature optimization: Introducing Module Pattern before there is evidence it is needed.

Practice Questions

1. What problem does the Module Pattern pattern solve? Describe a real-world scenario where using it improves code quality.

2. How does Module Pattern differ from alternative approaches? What are the trade-offs?

3. What testing Strategy would you use for code that implements Module Pattern?

4. How would you refactor legacy code to introduce Module Pattern?

5. When should you NOT use Module Pattern? Describe scenarios where it adds unnecessary complexity.

Challenge

Implement a complete Module Pattern example in Python with unit tests. Include error handling, edge cases (empty data, null values, concurrent access), and a performance comparison against a simpler alternative. Document your design decisions.

Real-World Task

Find a section of code in your current project that could benefit from the Module Pattern pattern. Refactor it, write tests, and measure the improvement in testability, coupling, and cohesion.

Security Tip: When implementing Module Pattern, ensure proper input validation, avoid exposing internal state, and follow Least Privilege. At DodaTech, all implementations undergo security review.

Built by the developers of Doda Browser, DodaZIP, and Durga Antivirus Pro.