Usage Examples
This directory (/examples) can be deleted when forking this project. It contains some simple examples of how forks of es7-typescript-starter can be used by other projects. (Usually you'll want to provide these instructions in your root readme.md.)
Node (Vanilla)
This shows the simplest use case – a quick, hacked-together Node.js project with no type safety, and no pre-processing. This is the way most of the Node.js ecosystem currently expects to import a node modules.
# build es7-typescript-starter first
yarn build
cd examples/node-vanilla
# run the example
node test.js
Node (Typescript)
This is for larger and more established Node.js projects which use Typescript for type safety. You'll notice that the type declarations and inline documentation from es7-typescript-starter are accessible to Typescript-compatible editors like vscode.
# build es7-typescript-starter first
yarn build
cd examples/node-typescript
# install the dependencies
yarn
# type-check and build the example
yarn build
# run the example
yarn start
Browser (tree-shaking with Rollup)
This project imports the power and asyncABC functions from the ES6 output of es7-typescript-starter, without importing the double function. This allows for the double method to be completely excluded from output via Rollup's tree-shaking, making the final javascript bundle potentially much smaller, even before using a minifier like Uglify.
To demonstrate, this example doesn't minify or remove comments. You can see where some javascript has been excluded from the bundle.
# build es7-typescript-starter first
yarn build
cd examples/browser
# install the dependencies
yarn
# build the javascript bundle
yarn build
# start a server and open the test in a browser
yarn start