Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

published TypeScript definitions incompatible with @types/nock

See original GitHub issue

What is the expected behavior?

Nock TypeScript definitions should work similarly to how they behaved prior to types being introduced.

What is the actual behavior?

Prior to nock publishing TypeScript definitions, I was using the library with @types/nock instanced, and importing the module like so:

import * as nock from 'nock'

With the new types I receive this exception importing:

test/github.ts:24:6 - error TS2339: Property 'disableNetConnect' does not exist on type 'typeof import("/usr/local/google/home/bencoe/google/github-repo-automation/node_modules/nock/types/index")'.

24 nock.disableNetConnect();

If I switch to the following syntax, as recommended in #1684:

import nock from 'nock'

I instead receive the following exception:

nock.disableNetConnect();
     ^
TypeError: Cannot read property 'disableNetConnect' of undefined
    at Object.<anonymous> (/usr/local/google/home/bencoe/google/github-repo-automation/test/github.ts:24:6)
    at Module._compile (internal/modules/cjs/loader.js:868:30)

How to reproduce the issue

My typescript configuration is as follows:

{
  "extends": "./node_modules/gts/tsconfig-google.json",
  "compilerOptions": {
    "target": "es2015",
    "rootDir": ".",
    "outDir": "build"
  },
  "include": [
    "src/*.ts",
    "src/**/*.ts",
    "test/*.ts",
    "system-test/*.ts"
  ]
}

where tsconfig-google.json is equal to:

{
  "compilerOptions": {
    "allowUnreachableCode": false,
    "allowUnusedLabels": false,
    "declaration": true,
    "forceConsistentCasingInFileNames": true,
    "lib": ["es2016"],
    "module": "commonjs",
    "noEmitOnError": true,
    "noFallthroughCasesInSwitch": true,
    "noImplicitReturns": true,
    "pretty": true,
    "sourceMap": true,
    "strict": true,
    "target": "es2017"
  },
  "exclude": [
    "node_modules"
  ]
}

I believe perhaps the root cause is an incompatibility with the types, as defined, and the commonjs module setting in TypeScript, unfortunately this is a standard configuration we’re currently using across dozens of repos.

Versions