Fix exports type definitions #234
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
According to the type definitions, this library had to be used like
this:
```js
// CJS
const jsQR = require('jsqr')
jsQR.default(/* … */)
```
```js
// ESM
import jsQR from 'jsqr'
jsQR.default(/* … */)
```
However, this doesn’t match the instructions from the readme.
This issue has become more apparent since the introduction of the
`"module": "node16"` option in TypeScript 4.7. The correct way to type
`module.exports =` is `export =`.
People can still use default imports when compiling to CJS. This
requires them to use the `esModuleInterop` option (which they need
anyway if they want to use it with other libraries).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
According to the type definitions, this library had to be used like this:
However, this doesn’t match the instructions from the readme.
This issue has become more apparent since the introduction of the
"module": "node16"option in TypeScript 4.7. The correct way to typemodule.exports =isexport =.People can still use default imports when compiling to CJS. This requires them to use the
esModuleInteropoption (which they need anyway if they want to use it with other libraries).