Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: show how you can get the types to work in a commonjs module #2550

Merged
merged 2 commits into from
Mar 22, 2019
Merged

docs: show how you can get the types to work in a commonjs module #2550

merged 2 commits into from
Mar 22, 2019

Conversation

joshstevens19
Copy link
Contributor

Description

A issue was raised a few weeks ago about how to get the typing's to work in a commonjs module.

#2486

I have now added instructions in the README.md so others can easily find how to get it working.

Type of change

  • Bug fix
  • New feature
  • Breaking change
  • Enhancement

Checklist:

  • I have selected the correct base branch.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no warnings.
  • I have updated or added types for all modules I've changed
  • Any dependent changes have been merged and published in downstream modules.
  • I ran npm run test in the root folder with success and extended the tests if necessary.
  • I ran npm run build in the root folder and tested it in the browser and with node.
  • I ran npm run dtslint in the root folder and tested that all my types are correct
  • I have tested my code on an ethereum test network.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 98.651% when pulling 4183cdc on joshstevens19:update-readme-to-get-types-with-commonjs into 1a7c600 on ethereum:1.0.

@nivida nivida merged commit ae35123 into web3:1.0 Mar 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants