typechain - npm Package Compare versions
Comparing version 2.0.0-beta2 to 2.0.0
@@ -11,3 +11,3 @@ { | ||
| ], | ||
| "version": "2.0.0-beta2", | ||
| "version": "2.0.0", | ||
| "license": "MIT", | ||
@@ -14,0 +14,0 @@ "repository": "https://github.com/ethereum-ts/Typechain", |
@@ -48,4 +48,4 @@ <p align="center"> | ||
| | [`@typechain/truffle-v4`](/packages/@typechain/truffle-v4) | [](https://www.npmjs.com/package/@typechain/truffle-v4) | Truffle ver 4 support | [example](./examples/truffle-v4) | | ||
| | [`@typechain/truffle-v5`](/packages/@typechain/truffle-v5) | [](https://www.npmjs.com/package/@typechain/truffle-v5) | Truffle ver 5 support | [example](./examples/truffle-v5) | | ||
| | [`@typechain/web3-v1`](/packages/@typechain/web3-v1) | [](https://www.npmjs.com/package/@typechain/web3-v1) | Web3 ver 1 support | [example](./examples/web3-v1) | | ||
| | [`@typechain/web3-v2`](/packages/@typechain/web3-v2) | [](https://www.npmjs.com/package/@typechain/web3-v2) | Web3 ver 2 support | [example](./examples/web3-v2) | | ||
@@ -57,3 +57,3 @@ ## Usage | ||
| ``` | ||
| typechain --target=(ethers|truffle|web3-v1|web3-v2|path-to-custom-target) [glob] | ||
| typechain --target=(ethers|truffle|web3-v1|path-to-custom-target) [glob] | ||
| ``` | ||
@@ -65,3 +65,3 @@ | ||
| `typechain-target-${target}`, so make sure that desired package is installed. | ||
| - `--outDir` - put all generated files to a specific dir | ||
| - `--outDir` (optional) - put all generated files to a specific dir | ||
@@ -104,5 +104,3 @@ TypeChain always will rewrite existing files. You should not commit them. Read more in FAQ section. | ||
| That's it! Now, just import contract bindings as any other file | ||
| `import { MyAwesomeContract } from './contracts/MyAwesomeContract'` and start interacting with it. We use named exports | ||
| because of [this](https://blog.neufund.org/why-we-have-banned-default-exports-and-you-should-do-the-same-d51fdc2cf2ad). | ||
| That's it! Now, you can simply import typings, check out our examples for more details. | ||
@@ -130,7 +128,6 @@ ## Targets 🎯 | ||
| ### Web3-2.0.0 | ||
| ### NatSpec support | ||
| Generates typings for contracts compatible with (unstable) Web3.js 2.x.x version. Typings for library itself are now | ||
| part of `Web3 2.0.0` library so nothing additional is needed. | ||
| [Usage example](https://github.com/ethereum-ts/TypeChain/blob/master/test/integration/targets/web3-v2/DumbContract.spec.web3.ts#L12). | ||
| If you provide solidity artifacts rather than plain ABIs as an input, TypeChain can generate NatSpec comments directly | ||
| to your typings which enables simple access to docs while coding. | ||
@@ -143,7 +140,2 @@ ### Your own target | ||
| ## Migration guide | ||
| For users of 0.x.x versions: the only breaking change is extraction of targets for separate packages so now you need to | ||
| install `typechain-target-${name}` for each target. | ||
| ## FAQ 🤔 | ||
@@ -150,0 +142,0 @@ |
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
Improved metrics
- Number of low quality alerts
- decreased by-50%
1
Worsened metrics
- Total package byte prevSize
- decreased by-0.29%
181007
- Number of lines in readme file
- decreased by-3.77%
204