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.

Sign up for GitHub

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

Jump to bottom

fix(pkg): add a default fallback export #733

Merged
merged 3 commits into from
Apr 16, 2024
Merged

fix(pkg): add a default fallback export #733

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b678490
fix(pkg): add a `default` fallback export
wolfy1339 Apr 16, 2024
e7d4341
docs: add note on needed config changes for TypeScript
wolfy1339 Apr 16, 2024
f0aaee6
docs(README): update info for typescript
wolfy1339 Apr 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
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
View file
Open in desktop
Original file line number Diff line number Diff line change
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