Skip to content

Commit

Permalink
docs: mention additional requirement for TS
Browse files Browse the repository at this point in the history
closes #867
  • Loading branch information
jasonkuhrt committed May 16, 2024
1 parent 2e7d6f2 commit 92ea1b2
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,10 @@ npm add graphql-request graphql

#### TypeScript Setup

This package uses [`package.exports`](https://www.typescriptlang.org/docs/handbook/modules/reference.html#packagejson-exports). Therefore if you are a TypeScript user you must also have your `tsconfig.json` `moduleResolution` set to [`bundler`](https://www.typescriptlang.org/docs/handbook/modules/reference.html#bundler) or [`node16`/`nodenext`](https://www.typescriptlang.org/docs/handbook/modules/reference.html#node16-nodenext-1).
This package uses [`package.exports`](https://www.typescriptlang.org/docs/handbook/modules/reference.html#packagejson-exports). Therefore if you are a TypeScript user you must:

1. have your `tsconfig.json` `moduleResolution` set to [`"bundler"`](https://www.typescriptlang.org/docs/handbook/modules/reference.html#bundler) or [`"node16"`/`"nodenext"`](https://www.typescriptlang.org/docs/handbook/modules/reference.html#node16-nodenext-1).
2. Have your `package.json` `type` set to `"module"`.

## Quick Start

Expand Down

0 comments on commit 92ea1b2

Please sign in to comment.