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

Properly include and export TypeScript types #248

Merged
merged 1 commit into from
Sep 18, 2023
Merged

Properly include and export TypeScript types #248

merged 1 commit into from
Sep 18, 2023

Commits on Sep 15, 2023

  1. Properly include and export TypeScript types

    We need to copy the entrypoing typings file, as described in [the
    TypeScript docs]:
    
    > It’s important to note that the CommonJS entrypoint and the ES
    > module entrypoint each needs its own declaration file, even if the
    > contents are the same between them. Every declaration file is
    > interpreted either as a CommonJS module or as an ES module, based on
    > its file extension and the `"type"` field of the `package.json`, and
    > this detected module kind must match the module kind that Node will
    > detect for the corresponding JavaScript file for type checking to be
    > correct. Attempting to use a single `.d.ts` file to type both an ES
    > module entrypoint and a CommonJS entrypoint will cause TypeScript to
    > think only one of those entrypoints exists, causing compiler errors
    > for users of the package.
    
    [the TypeScript docs]: https://www.typescriptlang.org/docs/handbook/esm-node.html
    
    Closes #247
    nex3 committed Sep 15, 2023
    Configuration menu
    Copy the full SHA
    0f4b0c9 View commit details
    Browse the repository at this point in the history