The Pattern Library project provides reusable design pattern componenets to be used in Javascript/Typescript projects. These components help achieve a loosely coupled design for re-occuring coding problems. The components exposed in this library are by no means complete and we actively seek contributions from our open-source community to expand it further.

Installlation

You can use this library in your project by running the following at your project root:

npm i @designpattern/pattern-lib

Documentation and Examples

We have contributed the following design patterns so far to the library. We have also contributed fully working examples for each of the patterns. Click on the links below to navigate to the detailed documentation or example usage for each.

| Patterns | Descriptions | Docs | Examples | | --------------- | ------------------------------------------ | :----------------------: | :-----------------------------: | | Strategizer | Provides configurable execution strategies | docs | example | | Transformer | Provides configurable transformations | docs | example | | Factory | Provides configurable factory | docs | example |

You can run any of the patterns from the root of the project by running the npm run eg examples/<pattern-name> command. Here is an example command to run the Strategizer pattern:

npm run eg examples/strategizer

Contributing

We are actively seeking contributions of reusable patterns from our open-source community. Please read the following to learn how to contribute to the project:

Code of Conduct

We have adopted a Code of Conduct that we expect our contributors to honor. Please read the full text for more information.

Contributing Guide

Please read our Contributing Guide to understand our process to contribute bugfixes and new patterns to the project.

License

This project is licensed under the MIT License.