在node.js中扩展TypeScript Global对象

Question

我有一个node.js应用程序,它将一些配置信息附加到global对象:

global.myConfig = {
    a: 1,
    b: 2
}

TypeScript编译器不喜欢这个,因为该Global类型没有名为的对象myConfig:

TS2339:"全局"类型中不存在属性"myConfig".

我不想这样做:

global['myConfig'] = { ... }

如何扩展Global类型以包含myConfig或仅告诉TypeScript闭嘴并信任我？我更喜欢第一个.

我不想改变里面的声明node.d.ts.我看到了这个SO帖子并尝试了这个:

declare module NodeJS  {
    interface Global {
        myConfig: any
    }
}

作为扩展现有Global界面的一种方式,但它似乎没有任何影响.

Answer 1

我看到了这个SO帖子并尝试了这个:

你可能有类似的东西vendor.d.ts:

// some import 
// AND/OR some export

declare module NodeJS  {
    interface Global {
        spotConfig: any
    }
}

您的文件需要清除任何根级别import或exports.这会将文件转换为模块并将其与全局类型声明命名空间断开连接.

更多:https://basarat.gitbooks.io/typescript/content/docs/project/modules.html

Answer 2

为了避免Typescript声称这样的事情:

TS2339:"全局"类型中不存在属性"myConfig".

我建议定义自定义类型.我src/types/custom.d.ts在我的项目中的文件下做:

declare global {
  namespace NodeJS {
    interface Global {
        myConfig: {
          a: number;
          b: number;
        }
    }
  }
}

然后我确保tsconfig.json文件中的Typescript考虑这些:

{
  ...
  "files": [
    ...
    "src/types/custom.d.ts"
  ]
}

现在您可以安全地使用自定义属性:

console.log(global.myConfig.a);

Answer 3

将以下文件放入项目的根目录中.

global.d.ts

declare namespace NodeJS {
  export interface Global {
    myConfig: any
  }
}

我们正在使用"@types/node": "^7.0.18"和TypeScript Version 2.3.4.我们的tsconfig.json文件如下所示:

{
    "compilerOptions": {
        "module": "commonjs",
        "target": "es6"  
    },
    "exclude": [
        "node_modules"
    ]
}

Answer 4

由于node@16该NodeJS.Global界面已被移除以支持globalThis.

您可以在模块文件中将新的全局变量声明为：

declare global {
  var NEW_GLOBAL: string;
}

在非模块文件（没有顶级导入/导出）中：

declare var NEW_GLOBAL: string;

重要提示：变量必须声明为var. let或const变量未显示在globalThis.

Answer 5

使用“命名空间”而不是“模块”来声明自定义 TypeScript

如果您使用上述任何答案，并且使用的是较新版本的 Typescript，您将收到关于使用"module"的唠叨。您应该考虑命名空间。

为了满足这里的要求，您实际上需要的不仅仅是扩展 Global 接口。如果您希望它可以直接从“globalThis”上下文访问，您还需要使用该类型创建一个常量。

注意：虽然 OP 询问对象文字，但过程与您在下面看到的相同。而不是“调试”类型是一个函数，您只需根据需要定义接口，然后将“调试：”更改为 myConfig 或您希望的任何内容。

// typically I'll store the below in something like "typings.d.ts"
// this is because, at least typically, these overrides tend to
// be minimal in nature. You could break them up and Typescript
// will pick them up if you wish.

// Augmentations for the global scope can only be directly nested 
// in external modules or ambient module declarations.
export {}

declare global {
  // Definition or type for the function.
  type Debug = (label: string) => (message: any, ...args: any[]) => void

  // If defining an object you might do something like this
  // interface IConfig { a: number, b: number }

  // Extend the Global interface for the NodeJS namespace.
  namespace NodeJS {
    interface Global {
      // Reference our above type, 
      // this allows global.debug to be used anywhere in our code.
      debug: Debug
    }
  }
  
  // This allows us to simply call debug('some_label')('some debug message')
  // from anywhere in our code.
  const debug: Debug
}

如何使用上述内容

在这个例子中，为了完整起见，我们所做的只是定义了一个全局变量，这样我们就可以记录一条简单的调试消息。下面是我们如何将方法绑定到我们的全局上下文。

global.debug = (label: string) => (message: any, ...args: any[]) => console.log(message, ...args)

我们也可以直接调用我们的全局调试方法：

debug('express')(`${req.method}: ${req.url}`)

Answer 6

唯一对我有用的是:

// lib/my.d.ts

import Global = NodeJS.Global;
export interface CDTGlobal extends Global {
  cdtProjectRoot: string
}

然后在其他文件中使用它

import {CDTGlobal} from "../lib/my.d.ts";
declare const global: CDTGlobal;

const cwd = global.cdtProjectRoot; // works

Answer 7

对我有用的是：

declare global {
  module NodeJS {
    interface Global {
      myConfig: any;
    }
  }
}

global.myConfig = 'it works!';

唯一的缺点是在使用它时你必须关闭 ESLint 规则@typescript-eslint/no-namespace。

为了完整起见，这里是我的tsconfig.json：

{
  "compilerOptions": {
    "declaration": true,
    "emitDecoratorMetadata": true,
    "esModuleInterop": true,
    "experimentalDecorators": true,
    "forceConsistentCasingInFileNames": true,
    "jsx": "react",
    "lib": ["dom", "es2017"],
    "module": "commonjs",
    "moduleResolution": "node",
    "noEmitOnError": true,
    "noImplicitReturns": true,
    "noUnusedLocals": true,
    "noUnusedParameters": true,
    "outDir": "dist",
    "removeComments": true,
    "resolveJsonModule": true,
    "rootDir": "src",
    "sourceMap": true,
    "strict": true,
    "target": "es6"
  },
  "exclude": ["dist", "node_modules"]
}