fix: export cjs and es #1298
Merged
fix: export cjs and es #1298
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
leonardlin
previously approved these changes
Apr 18, 2021
| For Typescript, Webpack or other module imports, use `agenda/es` entrypoint: | ||
| e.g. | ||
| ```ts | ||
| import { Agenda } from 'agenda/es'; |
There was a problem hiding this comment.
I would make a note that people migrating from @types/agenda should change their imports
from: import Agenda from 'agenda'
to: import { Agenda} from 'agenda/es'
There was a problem hiding this comment.
added it to the readme
leonardlin
previously approved these changes
Apr 20, 2021
|
Couldn't you just add export = AgendaIn index.ts |
Unfortunately not, this would overwrite all other exports and would therefore not work correctly. It would only fix the plain JS includes, but this does my PR too. |
…estructuring. Update README a bit.
koresar
approved these changes
May 1, 2021
|
Thanks for the additional fixes and tests! Lgtm too, feel free to merge |
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.
as commented in #1266, this one would restore the old behaviour and introduces a new entrypoint for es modules.
for CJS (javascript):
const Agenda = require('agenda');or for module (typescript):
import Agenda from 'agenda/es'This is a "another" breaking change though, as a named import would not work with the default entrypoint anymore (didn't work before, but did now in the patch releases)