microsoft / TypeScript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
https://www.typescriptlang.org
Apache License 2.0
100.98k stars 12.48k forks source link

Cannot use type side of a namespace in JsDoc after `declare global ...` workaround for UMD globals #26486

Open billti opened 6 years ago

billti commented 6 years ago

I hit this while writing an electron app using checkJs where you can both require code in (thus making your file a module), and there may also be script tags loading code in the HTML for the app. For example, by main page has the below as it is using D3. Thus the 'd3' object is available globally.

    <script src="node_modules/d3/dist/d3.js"></script>
    <script src="./app.js"></script>

Trying to use the global D3 in my app.js however results in the error 'd3' refers to a UMD global, but the current file is a module..., so I've added the common workaround below to avoid this via a .d.ts file.

import {default as _d3} from 'd3';

declare global {
    // Make the global d3 from directly including the bundle via a script tag available as a global
    const d3: typeof _d3;
}

When the above .d.ts code is present (and only when), JSDoc gives an error on trying to use types from the namespace, i.e. the below code

/** @type {d3.DefaultArcObject} */
var x;

Results in the error Namespace '"./@types/d3/index".d3' has no exported member 'DefaultArcObject'. Yet the below TypeScript continues to work fine:

var x: d3.DefaultArcObject;

The below also continues to work fine in JavaScript, but is kind of ugly and a pain to have to repeat (especially if you need to use a lot of type arguments)

/** @type {import('d3').DefaultArcObject} */
var x;

Personally I'd rather not have to do the .d.ts workaround at all and just be able to use the d3 global in my modules (see the highly controversial #10178). That not being the case, JsDoc should be able to access the types still with the workaround in place.

sandersn commented 5 years ago

For future investigation, here's a small repro (I think):

// @Filename: ex.d.ts
import * as _d3 from './d3'
declare global {
    const d3: typeof _d3;
}
// @Filename: d3.ts
interface DefaultArcObject {
    a: number
}
// @Filename: use.js
/** @type {d3.DefaultArcObject} BROKEN */
var x;
/** @type {import('./d3').DefaultArcObject} OK */
var y;

Note that d3 has export as namespace d3 now so the original example should work.