It contains TypeScript examples for all classic GoF design patterns. Each pattern includes two examples:
-
Conceptual examples show the internal structure of patterns, including detailed comments.
-
RealWorld examples show how patterns can be used in real-world web applications.
For simplicity reasons, the examples are console apps. In order to launch them, you have to install Node.js and NPM on your computer and then install TypeScript compiler and TypeScript Node extension like this:
npm install -g typescript
npm install -g ts-node
When you have all the required software installed, the examples can be launched via the command line as follows:
ts-node src/Path-to-example/Example.ts
For the best experience, I recommend working with examples with these IDEs:
Here's a style guide which might help you to keep your changes consistent with the rest of the project's code:
-
All code should follow these two guidelines: Unofficial TypeScript StyleGuide and Airbnb JavaScript Style Guide.
-
Try to hard wrap the code at 80th's character. It helps to list the code on the website without scrollbars.
-
Example files should be located and named in the following manner:
src/{PatternName}/{ExampleName}/index.ts -
Aim to put all code within one file. Yes, I realize that it's not how it supposed to be done in production. But it helps people to better understand examples, since all code fits into one screen.
This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.
