Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
PR adds the current TS config guidelines to the
Getting Started
section of the docs. At the moment these are in the GitHub README where fewer people might see them.#2363
#3198
#3215
There are several issues where TS users report difficulty importing Web3 modules because the underlying JS exports like this: (example)
but the types don't define a default export. This does not affect people who configure their tsconfig with
esModuleInterop: true
. This setting is the default in a tsconfig generated withtsc --init
.The issue affects 16 of 20 Web3 modules. It does not affect the main module or utils.
In #3125 @alcuadrado comments:
Questions:
esModuleInterop
? Does it cause significant levels of inconvenience or break other common packages for users?Type of change
Checklist: