Skip to content

Commit

Permalink
fix(pkg): add a default fallback export (#733)
Browse files Browse the repository at this point in the history
* fix(pkg): add a `default` fallback export

See octokit/core.js#665 octokit/core.js#667

* docs: add note on needed config changes for TypeScript
  • Loading branch information
wolfy1339 committed Apr 16, 2024
1 parent 85bf1df commit 81720c7
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
6 changes: 6 additions & 0 deletions README.md
Expand Up @@ -50,6 +50,12 @@ There is one method for each REST API endpoint documented at [https://developer.

## TypeScript

> [!IMPORTANT]
> As we use [conditional exports](https://nodejs.org/api/packages.html#conditional-exports), you will need to adapt your `tsconfig.json` by setting `"moduleResolution": "node16", "module": "node16"`.
>
> See the TypeScript docs on [package.json "exports"](https://www.typescriptlang.org/docs/handbook/modules/reference.html#packagejson-exports).<br>
> See this [helpful guide on transitioning to ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) from [@sindresorhus](https://github.com/sindresorhus)
Parameter and response types for all endpoint methods exported as `{ RestEndpointMethodTypes }`.

Example
Expand Down
3 changes: 2 additions & 1 deletion scripts/build.mjs
Expand Up @@ -53,12 +53,13 @@ async function main() {
{
...pkg,
files: ["dist-*/**"],
main: "./dist-src/index.js",
types: "./dist-types/index.d.ts",
exports: {
".": {
import: "./dist-src/index.js",
types: "./dist-types/index.d.ts",
// Tooling currently are having issues with the "exports" field when there is no "default", ex: TypeScript, eslint
default: "./dist-types/index.js",
},
},
sideEffects: false,
Expand Down

0 comments on commit 81720c7

Please sign in to comment.