Close to working with TypeScript, but not quite -- Error: "Cannot find name RequestInit"

[n8sabes]

graphql-request doesn't work with TypeScript projects. I'm seeing the following error:

node_modules/graphql-request/dist/src/types.d.ts(5,14): error TS2304: Cannot find name 'RequestInit'

I found the following related issue:
RequestInit is not defined

Any help getting graphql-request working in TypeScript would be appreciated.

Thank you.

[kbrandwijk]

Unable to reproduce in the current version.

[maxdarque]

I get this in when I run tsc on "graphql-request": "^1.4.0",

[schickling]

Can you try adding dom to your libs array?

Example:

{
  "compilerOptions": {
    "target": "es5",
    "moduleResolution": "node",
    "module": "commonjs",
    "sourceMap": true,
    "noUnusedLocals": true,
    "rootDir": "src",
    "outDir": "dist",
    "lib": [
      "dom"
    ]
  }
}

[maxdarque]

@schickling thanks that works

[lednhatkhanh]

You should not include a dom lib to an api project, it may leads to some weird behaviors.

[schickling]

@lednhatkhanh while I haven't seen any issues with this yet, do you have any other suggestions? Using fetch in TypeScript is definitely weird in general in regards to type definitions.

cc @Andy-MS @RyanCavanaugh

fetch is normally a DOM-only API -- this package appears to have an API similar to fetch, but not the same. It's used like:

export interface Options {
    method?: RequestInit['method'];
    headers?: Headers;
    mode?: RequestInit['mode'];
    credentials?: RequestInit['credentials'];
    cache?: RequestInit['cache'];
    redirect?: RequestInit['redirect'];
    referrer?: RequestInit['referrer'];
    referrerPolicy?: RequestInit['referrerPolicy'];
    integrity?: RequestInit['integrity'];
}

Maybe the best solution would be to just copy the relevant parts instead of referencing RequestInit. There's also microsoft/TypeScript#15780 which would allow you to pull in dom typings without users needing to modify tsconfig.json, but that then adds a bunch of globals that they might not need.

[divyenduz]

With the latest version - 1.7.0 I ran only into error TS2304: Cannot find name 'AsyncIterable'. in node_modules/@types/graphql/subscription/subscribe.d.ts

[maxdarque]

@divyenduz are you including esnext.asynciterable under the tsconfig.json lib option?

{
  "compilerOptions": {
    "target": "es2017",
    "lib": [ "es2017", "dom", "esnext.asynciterable" ],
    "moduleResolution": "node",
    "module": "commonjs",
    "sourceMap": true,
    "rootDirs": ["src", "stress-tests"],
    "outDir": "dist",
    "removeComments": true,
    "strictNullChecks": false,
    "noUnusedLocals": false,
    "noUnusedParameters": false
  }
}

[divyenduz]

Nope, to test this out I used the following (empty) tsconfig.json

{}

[maxdarque]

I don't quite follow. So have you tried adding esnext.asynciterable to the tsconfig.json lib option?

[divyenduz]

Ah! got it now, yes it works with esnext.asynciterable. The idea was to make it work without any additions to tsconfig.json but this won't be possible for AsyncIterable because the dep is in graphql-js. Thanks!