Skip to content
This repository was archived by the owner on Oct 11, 2022. It is now read-only.
This repository was archived by the owner on Oct 11, 2022. It is now read-only.

[SUGGESTION] Use a standard CommonJS export #28

Description

@WaldoJeffers

Currently, callback-to-async-iterator is written using ES6 modules, and transpiled to CommonJS using babel-plugin-transform-modules-commonjs.

The export in the result file in the dist folder looks like this:

exports.default = callbackToAsyncIterator;

which means in a standard CommonJS environment, you have to write something like this to use it:

const callbackToAsyncIterator = require('callback-to-async-iterator').default

This is a bit unexpected, because I think this module is primarily targeted at NodeJS environments, and the docs don't mention it.

I would suggest using regular CommonJS exports in the source code, to make sure the exported dist/index.js file looks like this:

module.exports = callbackToAsyncIterator

This will probably not make any differences for people using it in a ES6 module environment, because tools like Babel or Webpack usually interop quite nicely with CommonJS modules.

What are your thoughts on this? I can work on a PR if that sounds good

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions