vndb/mithril-vndb
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Edit types installation to be clearer and easier to find (#2435)

Browse source
This commit is contained in:
spacejack 2019-06-20 07:02:02 -04:00 • committed by Isiah Meadows
parent 10f0b4934a
commit 696b5cbfe3
1 changed files with 14 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

26
docs/installation.md
View file

@ -21,6 +21,20 @@ If you're new to JavaScript or just want a very simple setup to get your feet we
$ npm install mithril@next --save $ npm install mithril@next --save
``` ```
TypeScript type definitions are available from DefinitelyTyped. They can be installed with:
```bash
$ npm install @types/mithril --save-dev
```
For example usage, to file issues or to discuss TypeScript related topics visit: https://github.com/MithrilJS/mithril.d.ts
Type definitions for pre-release versions of Mithril (on the `next` branch) align with the `next` branch of the [types development repo](https://github.com/MithrilJS/mithril.d.ts/tree/next). You can install these types with:
```bash
$ npm install -D MithrilJS/mithril.d.ts#next
```
--- ---
### Quick start with Webpack ### Quick start with Webpack
@ -259,15 +273,3 @@ If you don't have the ability to run a bundler script due to company security po
// if a CommonJS environment is not detected, Mithril will be created in the global scope // if a CommonJS environment is not detected, Mithril will be created in the global scope
m.render(document.body, "hello world") m.render(document.body, "hello world")
``` ```
---
### TypeScript
TypeScript type definitions are available from DefinitelyTyped. They can be installed with:
```bash
$ npm install @types/mithril --save-dev
```
For example usage, to file issues or to discuss TypeScript related topics visit: https://github.com/MithrilJS/mithril.d.ts