In this article, we will learn how to use and implement the Proxy Pattern in TypeScript with an example.

Proxy is a structural design pattern that lets you provide a substitute or placeholder for another object. A proxy controls access to the original object, allowing you to perform something either before or after the request gets through to the original object.

TypeScript Proxy Pattern Example

The below diagram shows the generic structure of the Proxy Pattern:

Let's refer to the above structure to create an example to demonstrates the usage of the Proxy Pattern.

Let's create proxy.ts file and add the following code to it:

export interface Subject {
    doAction(): void;
}

export class Proxy implements Subject {
    private realSubject: RealSubject;
    private s: string;

    constructor(s: string) {
        this.s = s;
    }

    public doAction(): void {
        console.log("`doAction` of Proxy(", this.s, ")");
        if (this.realSubject === null || this.realSubject === undefined) {
            console.log("creating a new RealSubject.");
            this.realSubject = new RealSubject(this.s);
        }
        this.realSubject.doAction();
    }
}

export class RealSubject implements Subject {
    private s: string;

    constructor(s: string) {
        this.s = s;
    }
    public doAction(): void {
        console.log("`doAction` of RealSubject", this.s, "is being called!");
    }
}

Usage

Let's create demo.ts file and add the following code to it:

import { Proxy } from "./proxy";

export function show() : void {
 var proxy1: Proxy = new Proxy("proxy1"),

 proxy2: Proxy = new Proxy("proxy2");

 proxy1.doAction();
 proxy1.doAction();
 proxy2.doAction();
 proxy2.doAction();
 proxy1.doAction();
}
show();

Run:

• Compile the above code using the TypeScript compiler.
• Above code is compiled to plan JavaScript code
• Run Javascript code using node

design_patterns_in_typescript\proxy> tsc --target ES5 .\demo.ts
design_patterns_in_typescript\proxy> node .\demo.js
`doAction` of Proxy( proxy1 )
creating a new RealSubject.
`doAction` of RealSubject proxy1 is being called!
`doAction` of Proxy( proxy1 )
`doAction` of RealSubject proxy1 is being called!
`doAction` of Proxy( proxy2 )
creating a new RealSubject.
`doAction` of RealSubject proxy2 is being called!
`doAction` of RealSubject proxy2 is being called!
`doAction` of Proxy( proxy2 )
`doAction` of RealSubject proxy2 is being called!
`doAction` of Proxy( proxy1 )
`doAction` of RealSubject proxy1 is being called!

All TypeScript Design Patterns

1. Creational Design Patterns

Creational patterns provide various object creation mechanisms, which increase flexibility and reuse of existing code.

1. TypeScript Singleton Pattern Example
2. TypeScript Factory Design Pattern with Example
3. TypeScript Abstract Factory Pattern Example
4. TypeScript Builder Pattern Example
5. TypeScript Prototype Pattern Example

2. Structural Design Patterns

Structural patterns explain how to assemble objects and classes into larger structures while keeping these structures flexible and efficient.

1. TypeScript Bridge Pattern Example
2. TypeScript Adapter Pattern Example
3. TypeScript Decorator Pattern Example
4. TypeScript Composite Pattern Example
5. TypeScript Flyweight Design Pattern Example
6. TypeScript Facade Pattern Example
7. TypeScript Proxy Pattern Example

3. Behavioral Design Patterns

Behavioral design patterns are concerned with algorithms and the assignment of responsibilities between objects.

1. TypeScript Command Pattern Example
2. TypeScript Chain of Responsibility Pattern Example
3. TypeScript Visitor Pattern Example
4. TypeScript Template Method Pattern Example
5. TypeScript Strategy Pattern Example
6. TypeScript State Pattern Example
7. TypeScript Observer Pattern Example
8. TypeScript Memento Pattern Example
9. TypeScript Mediator Pattern Example
10. TypeScript Iterator Pattern Example
11. TypeScript Interpreter Design Pattern Example