tsrun/readme.md

39 lines
1.8 KiB
Markdown
Raw Normal View History

2019-03-02 22:03:05 +00:00
# @gitzone/tsrun
2018-07-13 21:16:45 +00:00
run typescript programs efficiently
2019-03-02 22:03:05 +00:00
## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@gitzone/tsrun)
* [gitlab.com (source)](https://gitlab.com/gitzone/tsrun)
* [github.com (source mirror)](https://github.com/gitzone/tsrun)
* [docs (typedoc)](https://gitzone.gitlab.io/tsrun/)
2018-07-13 21:16:45 +00:00
## Status for master
2019-03-02 22:03:05 +00:00
[![build status](https://gitlab.com/gitzone/tsrun/badges/master/build.svg)](https://gitlab.com/gitzone/tsrun/commits/master)
[![coverage report](https://gitlab.com/gitzone/tsrun/badges/master/coverage.svg)](https://gitlab.com/gitzone/tsrun/commits/master)
2018-07-13 21:16:45 +00:00
[![npm downloads per month](https://img.shields.io/npm/dm/@gitzone/tsrun.svg)](https://www.npmjs.com/package/@gitzone/tsrun)
[![Known Vulnerabilities](https://snyk.io/test/npm/@gitzone/tsrun/badge.svg)](https://snyk.io/test/npm/@gitzone/tsrun)
2019-03-02 22:03:05 +00:00
[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
2018-07-13 21:16:45 +00:00
## Usage
2018-08-08 20:33:07 +00:00
2018-07-13 21:16:45 +00:00
Use TypeScript for best in class instellisense.
2018-12-05 23:26:17 +00:00
To simply run a TypeScript file on the fly type
```typescript
tsrun myfiletorun.ts
```
2019-03-02 22:03:05 +00:00
There are options available:
- `--web` will inject browser types. this is useful when testing code with polyfills on node, but that is meant for the browser later on.
2018-12-05 23:26:17 +00:00
2019-03-02 22:03:05 +00:00
For further information read the linked docs at the top of this readme.
2018-07-13 21:16:45 +00:00
2019-03-02 22:03:05 +00:00
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
2018-07-13 21:16:45 +00:00
2019-03-02 22:03:05 +00:00
[![repo-footer](https://gitzone.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)