499

我想将 string -> string 的映射存储在 Typescript 对象中，并强制所有键映射到字符串。例如：

var stuff = {};
stuff["a"] = "foo";   // okay
stuff["b"] = "bar";   // okay
stuff["c"] = false;   // ERROR!  bool != string

有没有办法让我强制这些值必须是字符串（或任何类型..）？

4

9 回答 9

844 
var stuff: { [key: string]: string; } = {};
stuff['a'] = ''; // ok
stuff['a'] = 4;  // error

// ... or, if you're using this a lot and don't want to type so much ...
interface StringMap { [key: string]: string; }
var stuff2: StringMap = { };
// same as above
于 2012-11-09T20:08:05.973 回答
217 
interface AgeMap {
    [name: string]: number
}

const friendsAges: AgeMap = {
    "Sandy": 34,
    "Joe": 28,
    "Sarah": 30,
    "Michelle": "fifty", // ERROR! Type 'string' is not assignable to type 'number'.
};

在这里，接口AgeMap强制将键作为字符串，将值强制作为数字。关键字name可以是任何标识符，应该用于建议您的接口/类型的语法。

您可以使用类似的语法来强制对象对联合类型中的每个条目都有一个键：

type DayOfTheWeek = "sunday" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday";

type ChoresMap = { [day in DayOfTheWeek]: string };

const chores: ChoresMap = { // ERROR! Property 'saturday' is missing in type '...'
    "sunday": "do the dishes",
    "monday": "walk the dog",
    "tuesday": "water the plants",
    "wednesday": "take out the trash",
    "thursday": "clean your room",
    "friday": "mow the lawn",
};

当然，您也可以将其设为泛型类型！

type DayOfTheWeek = "sunday" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday";

type DayOfTheWeekMap<T> = { [day in DayOfTheWeek]: T };

const chores: DayOfTheWeekMap<string> = {
    "sunday": "do the dishes",
    "monday": "walk the dog",
    "tuesday": "water the plants",
    "wednesday": "take out the trash",
    "thursday": "clean your room",
    "friday": "mow the lawn",
    "saturday": "relax",
};

const workDays: DayOfTheWeekMap<boolean> = {
    "sunday": false,
    "monday": true,
    "tuesday": true,
    "wednesday": true,
    "thursday": true,
    "friday": true,
    "saturday": false,
};

10.10.2018 更新： 在下面查看@dracstaxi 的答案 - 现在有一个内置类型Record可以为您完成大部分工作。

1.2.2020 更新： 我已经从我的答案中完全删除了预制的映射接口。@dracstaxi 的回答使它们完全无关紧要。如果您仍想使用它们，请查看编辑历史记录。

于 2016-09-01T21:35:03.717 回答
164

Record<T, K>快速更新：从 Typescript 2.1 开始，有一个像字典一样的内置类型。

在这种情况下，您可以声明如下内容：

var stuff: Record<string, any> = {};

您还可以通过联合文字类型来限制/指定潜在的键：

var stuff: Record<'a'|'b'|'c', string|boolean> = {};

这是使用文档中的记录类型的更通用示例：

// For every properties K of type T, transform it to U
function mapObject<K extends string, T, U>(obj: Record<K, T>, f: (x: T) => U): Record<K, U>

const names = { foo: "hello", bar: "world", baz: "bye" };
const lengths = mapObject(names, s => s.length);  // { foo: number, bar: number, baz: number }

TypeScript 2.1 文档Record<T, K>

我看到使用它的唯一缺点{[key: T]: K}是您可以对有用的信息进行编码，说明您正在使用哪种键来代替“键”，例如，如果您的对象只有主键，您可以像这样暗示：{[prime: number]: yourType}.

这是我为帮助进行这些转换而编写的正则表达式。这只会转换标签为“key”的情况。要转换其他标签，只需更改第一个捕获组：

寻找：\{\s*\[(key)\s*(+\s*:\s*(\w+)\s*\]\s*:\s*([^\}]+?)\s*;?\s*\}

代替：Record<$2, $3>

于 2018-07-03T19:31:17.203 回答
17

您可以将名称传递给未知键，然后编写您的类型：

type StuffBody = {
  [key: string]: string;
};

现在您可以在类型检查中使用它：

let stuff: StuffBody = {};

但是对于FlowType，不需要名称：

type StuffBody = {
  [string]: string,
};
于 2020-07-13T12:34:09.520 回答
10

@Ryan Cavanaugh 的回答完全可以并且仍然有效。仍然值得补充的是，截至 16 年秋季，当我们可以声称大多数平台都支持 ES6 时，当您需要将某些数据与某些键相关联时，几乎总是更好地坚持 Map。

我们在写let a: { [s: string]: string; }的时候要记住，typescript 编译好后就没有 type data 之类的东西了，它只是用来编译的。和 { [s: string]: string; } 将编译为 {}。

也就是说，即使你会写这样的东西：

class TrickyKey  {}

let dict: {[key:TrickyKey]: string} = {}

这只是不会编译（即使对于target es6，你会得到error TS1023: An index signature parameter type must be 'string' or 'number'.

所以实际上你受限于字符串或数字作为潜在的键，所以这里没有太多强制类型检查的感觉，特别是请记住，当 js 尝试通过数字访问键时，它会将其转换为字符串。

因此，即使键是字符串，也可以假设最佳做法是使用 Map 是非常安全的，所以我会坚持：

let staff: Map<string, string> = new Map();
于 2016-09-30T23:17:21.987 回答
10

定义接口

interface Settings {
  lang: 'en' | 'da';
  welcome: boolean;
}

强制键为设置界面的特定键

private setSettings(key: keyof Settings, value: any) {
   // Update settings key
}
于 2018-12-11T05:36:11.413 回答
6

实际上有一个内置的实用程序Record：

    const record: Record<string, string> = {};
    record['a'] = 'b';
    record[1] = 'c'; // leads to typescript error
    record['d'] = 1; // leads to typescript error
于 2022-01-19T13:19:40.123 回答
3

基于@shabunc 的回答，这将允许强制执行键或值（或两者）成为您想要强制执行的任何内容。

type IdentifierKeys = 'my.valid.key.1' | 'my.valid.key.2';
type IdentifierValues = 'my.valid.value.1' | 'my.valid.value.2';

let stuff = new Map<IdentifierKeys, IdentifierValues>();

也应该使用enum而不是type定义来工作。

于 2017-11-19T11:13:11.767 回答
1 
interface AccountSelectParams {
  ...
}
const params = { ... };

const tmpParams: { [key in keyof AccountSelectParams]: any } | undefined = {};
  for (const key of Object.keys(params)) {
    const customKey = (key as keyof typeof params);
    if (key in params && params[customKey] && !this.state[customKey]) {
      tmpParams[customKey] = params[customKey];
    }
  }

如果您了解这个概念，请发表评论

于 2020-09-04T12:43:33.403 回答