LBRYCommunity/bitcoinjs-lib
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

README: cleanup typescript help

Browse source
This commit is contained in:
Daniel Cousens 2017-09-05 14:53:30 +10:00 committed by GitHub
parent 4f1b80df52
commit f7d33c5357
1 changed files with 5 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -5,7 +5,6 @@
[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard) [![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
The pure JavaScript Bitcoin library for node.js and browsers. The pure JavaScript Bitcoin library for node.js and browsers.
Used by over a million wallet users and the backbone for almost all Bitcoin web wallets in production today. Used by over a million wallet users and the backbone for almost all Bitcoin web wallets in production today.
@ -81,22 +80,20 @@ uglifyjs ... --mangle --reserved 'Array,BigInteger,Boolean,ECPair,Function,Numbe
### Typescript or VSCode users ### Typescript or VSCode users
Type declarations for Typescript are available for version 3.0 of the library. To install, run: Type declarations for Typescript are available for version `^3.0.0` of the library.
``` bash ``` bash
npm install @types/bitcoinjs-lib npm install @types/bitcoinjs-lib
``` ```
You should now be able to use bitcoinjs-lib as if it was a typescript library. You can now use `bitcoinjs-lib` as a typescript compliant library.
e.g.,
``` javascript ``` javascript
import { HDNode, Transaction } from 'bitcoinjs-lib' import { HDNode, Transaction } from 'bitcoinjs-lib'
``` ```
VSCode (and possibly other editors) users writing plain javascript are also advised to install the type declarations, as the intelisense uses that information to help you code (autocompletion, static analysis). For VSCode (and other editors), users are advised to install the type declarations, as Intellisense uses that information to help you code (autocompletion, static analysis).
Report any typescript related bugs at [@dlebrecht DefinitelyTyped fork](https://github.com/dlebrecht/DefinitelyTyped), submit PRs to [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped)
Report bugs on the type declaration file at [@dlebrecht DefinitelyTyped fork](https://github.com/dlebrecht/DefinitelyTyped) or do a PR straight at [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped)
### Flow ### Flow
Definitions for [Flow typechecker](https://flowtype.org/) are available in flow-typed repository. Definitions for [Flow typechecker](https://flowtype.org/) are available in flow-typed repository.