Home

Awesome

Design Patterns and Idioms in ES6

A collection of design patterns and idioms in ES6

Boilerplate forked from angular/atscript-playground

Initial setup

# Clone the repo...
git clone https://github.com/ziyasal/design-patterns-in-es6.git
cd design-patterns-in-es6

# Then, you need to install all the dependencies...
npm install

# If you want to be able to use global commands `karma` and `gulp`...
npm install -g karma-cli gulp
# Do initial build, start a webserver and re-build on every file change...
gulp build serve watch

Open a browser and see the result.

Current Patterns

PatternDescription
abstract_factoryuse a generic function with specific factories
adapteradapt one interface to another using a whitelist
3-tierdata<->business logic<->presentation separation (strict relationships)
borga singleton with shared-state among instances
bridgea client-provider middleman to soften interface changes
buildercall many little discrete methods rather than having a huge number of constructor parameters
cataloggeneral methods will call different specialized methods based on construction parameter
chainapply a chain of successive handlers to try and process the data
commandbundle a command and arguments to call later
compositeencapsulate and provide access to a number of different objects
decoratorwrap functionality with other functionality in order to affect outputs
facadeuse one class as an API to a number of others
factory_methoddelegate a specialized function/method to create instances
flyweighttransparently reuse existing instances of objects with similar/identical state
graph_search(graphing algorithms, not design patterns)
mediatoran object that knows how to connect other objects and act as a proxy
mementogenerate an opaque token that can be used to go back to a previous state
mvcmodel<->view<->controller (non-strict relationships)
observerprovide a callback for notification of events/changes to data
poolpreinstantiate and maintain a group of instances of the same type
prototypeuse a factory and clones of a prototype for new instances (if instantiation is expensive)
proxyan object funnels operations to something else
publish_subscribea source syndicates events/data to 0+ registered listeners
statelogic is org'd into a discrete number of potential states and the next state that can be transitioned to
strategyselectable operations over the same data
templatean object imposes a structure but takes pluggable components
visitorinvoke a callback for all items of a collection
chaining_methodcontinue callback next object method
iteratorProvide a way to access the elements of an aggregate object sequentially

What are all the pieces involved?

Traceur

Transpiles AtScript code into regular ES5 (today's JavaScript) so that it can be run in a current browser.

RequireJS

Traceur is configured to transpile AtScript modules into AMD syntax and we use RequireJS to load the code in the browser.

Assert library

When typeAssertions: true option is used, Traceur generates run-time type assertions such as assert.type(x, Object). The assert library does the actual run-time check. Of course, you can use your own assert library.

The idea with type assertions is that you only use them during the development/testing and when deploying, you use typeAssertions: false.

Karma

Test runner that runs the tests in specified browsers, every time that you change a file.

Gulp

Task runner to make defining and running the tasks simpler.