TypeScript嵌套命名空间用字符串索引报错，如何解决？

问题背景 #

给定以下TypeScript嵌套命名空间：

namespace resource {
  export namespace item {
    export namespace housing {
      export const name = "Housing"
    }
    export namespace healthcare {
      export const name = "Healthcare"
    }
    export namespace food {
      export const name = "Food"
    }
  }
}

编写buy函数时，使用string类型的id通过括号表示法访问resource.item[id].name，触发如下类型错误：

Element implicitly has an 'any' type because expression of type 'string' can't be used to index type 'typeof item'.
No index signature with a parameter of type 'string' was found on type 'typeof item'.

需要实现通过括号表示法访问item下的字段，但现有公开方案多针对接口而非命名空间，因此寻求适配命名空间的解决办法。

可行解决方案 #

方案1：限制id为合法键的联合类型 #

将id的类型约束为resource.item的所有合法键的联合类型，让TypeScript明确识别可允许的索引值：

function buy(id: keyof typeof resource.item) {
  const itemName = resource.item[id].name;
  console.log(itemName);
}

// 合法调用示例
buy("housing"); // 输出 "Housing"
buy("healthcare"); // 输出 "Healthcare"

该方案最安全，编译阶段就能拦截非法的id传入，避免运行时错误。

方案2：给item添加索引签名 #

若需保留id的string类型，可以在item命名空间内添加字符串索引签名，声明所有字符串索引对应的结构类型：

namespace resource {
  export namespace item {
    // 添加字符串索引签名，声明所有索引对应的类型
    [key: string]: { name: string };
    
    export namespace housing {
      export const name = "Housing"
    }
    export namespace healthcare {
      export const name = "Healthcare"
    }
    export namespace food {
      export const name = "Food"
    }
  }
}

function buy(id: string) {
  // 需自行处理id不存在的情况，避免运行时报错
  if (!resource.item[id]) {
    console.error("无效的资源ID");
    return;
  }
  const itemName = resource.item[id].name;
  console.log(itemName);
}

注意：此方案会放宽类型检查，传入非法id时编译不会报错，需自行添加运行时校验逻辑。

方案3：临时类型断言 #

通过类型断言临时将resource.item转为带有字符串索引的类型，适合快速临时解决问题：

function buy(id: string) {
  // 断言为带有字符串索引的类型
  const itemMap = resource.item as Record<string, { name: string }>;
  // 建议添加存在性检查
  if (!itemMap[id]) {
    console.error("无效的资源ID");
    return;
  }
  const itemName = itemMap[id].name;
  console.log(itemName);
}

该方案跳过编译时类型检查，需确保业务逻辑中传入的id为合法值，否则可能引发运行时错误。

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