如何在NestJS中使用全局声明的对象？

问题核心 #

你遇到的本质问题是：TypeScript的全局类型声明和运行时值是分离的——全局作用域里的ImageFormat如果只是类型声明（比如type或interface），运行时根本不存在；如果是用declare const声明的全局对象，编译后也不会生成对应代码，自然会报“未定义”。

最优解决方案：单例类+全局类型导出 #

直接把ImageFormat做成包含类型和运行时值的单例，同时通过类型声明让它全局可用，无需重复导入：

1. 重构src/types/format.ts #

// 定义基础类型
export type ImageFormatType = 'jpg' | 'png' | 'webp';

// 实现运行时可用的对象
export const ImageFormat = {
  JPG: 'jpg' as const,
  PNG: 'png' as const,
  WEBP: 'webp' as const,
};

// 全局类型声明，让项目任意地方无需导入就能用类型
declare global {
  type ImageFormat = ImageFormatType;
  // 全局对象的类型声明，运行时靠导出的对象注入
  const ImageFormat: typeof ImageFormat;
}

// 导出供NestJS全局注入用的标识
export const IMAGE_FORMAT = Symbol('IMAGE_FORMAT');

2. 在NestJS根模块全局注册 #

在AppModule里把ImageFormat注册为全局提供者，所有模块无需导入就能注入：

import { Module, Global } from '@nestjs/common';
import { IMAGE_FORMAT, ImageFormat } from './types/format';

@Global()
@Module({
  providers: [
    {
      provide: IMAGE_FORMAT,
      useValue: ImageFormat,
    },
  ],
  exports: [IMAGE_FORMAT],
})
export class AppModule {}

3. 在业务代码中使用 #

• 类型层面：直接用ImageFormat类型，无需导入
• 运行时层面：通过依赖注入获取对象，或在工具函数中直接导入（单例模式，不会重复实例化）

服务中使用（依赖注入）

import { Inject, Injectable } from '@nestjs/common';
import { IMAGE_FORMAT } from '../types/format';

@Injectable()
export class ImageService {
  constructor(
    @Inject(IMAGE_FORMAT) private readonly imageFormat: typeof ImageFormat,
  ) {}

  isSupportedFormat(format: string): format is ImageFormat {
    return Object.values(this.imageFormat).includes(format as ImageFormat);
  }
}

独立工具函数中使用（直接导入）

import { ImageFormat } from '../types/format';

export function getSupportedFormats() {
  return Object.values(ImageFormat);
}

方案优势 #

• 无代码重复：类型和运行时值仅维护一次
• 全局类型复用：通过declare global让类型在任意文件直接使用
• 运行时可靠：依赖注入或直接导入保证对象存在，不会出现“未定义”错误
• 比ConfigService轻便：新增枚举值只需修改format.ts，无需额外配置

替代方案：TypeScript枚举（Enum） #

如果ImageFormat是简单键值对，也可以直接用TS枚举，它同时生成类型和运行时值：

// src/types/format.ts
export enum ImageFormat {
  JPG = 'jpg',
  PNG = 'png',
  WEBP = 'webp',
}

// 全局类型声明，让原始值类型全局可用
declare global {
  type ImageFormat = typeof ImageFormat[keyof typeof ImageFormat];
}

之后可直接导入枚举使用，若需全局注入，同样用Symbol注册为全局提供者即可。

内容的提问来源于stack exchange，提问作者Ray Kim