npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@codefrite/design-patterns

v1.1.10

Published

Common design-patterns in TypeScript

Downloads

14

Readme

Design Patterns

Typescript implementation of design patterns:

  • Singleton
  • Channel
  • Subscriber
  • EventHandler

Class Diagram

The diagram below shows the relation between the different classes and interfaces.

Event Handler

@startuml

skin rose

title Event Handler

class Singleton {

  • private static instance: object;
  • protected constructor() {}
  • public static getInstance = () => object; }

interface IChannel<MessageType, ReturnType> <> { + name: string; + subscribers: ISubscriber<MessageType, ReturnType>[]; + subscribe: (sub: ISubscriber<MessageType, ReturnType>) => void; + unsubscribe: (sub: ISubscriber<MessageType, ReturnType>) => void; + notify: (msg: MessageType) => Promise<PromiseSettledResult<Awaited>[]>; }

interface IEventHandler<MessageType, ReturnType> <> {

  • channels: Array<IChannel<MessageType, ReturnType>>;
  • createChannel: (name: string) => void;
  • getChannel: (name: string) => IChannel<MessageType, ReturnType> | undefined;
  • getChannels: () => Array<IChannel<MessageType, ReturnType>>;
  • subscribe: (chName: string, o: ISubscriber<MessageType, ReturnType>) => void;
  • unsubscribe: (chName: string, o: ISubscriber<MessageType, ReturnType>) => void;
  • notify: (chName: string, msg: MessageType) => Promise<PromiseSettledResult<Awaited>[]>; }

interface ISubscriber<MessageType, ReturnType> <> {

  • readonly id: string;
  • update: SubscriberCallback<MessageType, ReturnType>;
  • cb: SubscriberCallback<MessageType, ReturnType>; }

IChannel _-- ISubscriber IEventHandler _-- Singleton IEventHandler *-- IChannel

@enduml

Usage

Instantiating the Event Handler

To get a reference to the Singleton Event Handler, we can use the static getInstance() class method:

const eventHandler = EventHandler.getInstance<MessageType, ReturnType>();

Indeed, the constructor is declared protected and cannot (in TS at least) and shouldn't be invoked:

export default class EventHandler<MessageType, ReturnType> implements IEventHandler<MessageType, ReturnType> {
  ...

  private static instance: object;

  ...

  /**
   * constructor: Declared protected to defeat instantiation outside of class or child class (Singleton pattern)
   */
  protected constructor() {}

  /**
   * Returns the instance of the EventHandler class (Singleton pattern)
   * @returns the instance of the EventHandler class
   */
  public static getInstance = <MessageType, ReturnType>(): EventHandler<MessageType, ReturnType> =>
    !EventHandler.instance
      ? (EventHandler.instance = new EventHandler<MessageType, ReturnType>())
      : (EventHandler.instance as EventHandler<MessageType, ReturnType>);

  ...
};

Creating Channels

eventHandler.createChannel("keyboard-inputs");
eventHandler.createChannel("mouse-inputs");

Instantiating Subscriber and setting callback

const cb = () => {}
const sub = new Subscriber<MessageType, ReturnType>();
sub.setCallBack(cb)

Subscribing/Unsubscribing to Channel

eventHandler.subscribe("keyboard-inputs", sub);
eventHandler.unsubscribe("keyboard-inputs", sub);

Notifying the Event Handler

eventHandler.notify("keyboard-inputs", message)