为什么我不能间接返回一个对象文字来满足TypeScript中的索引签名返回类型?

时间:2014-02-27 18:19:35

标签: typescript

这三个函数似乎做同样的事情,但最后一个是错误。为什么会这样?

interface StringMap {
    [key: string]: string;
}

function a(): StringMap {
    return { a: "1" }; // OK
}

function b(): StringMap {
    var result: StringMap = { a: "1" };
    return result; // OK
}

function c(): StringMap {
    var result = { a: "1" };
    return result; // Error - result lacks index signature, why?
}

1 个答案:

答案 0 :(得分:29)

此行为即将消失。

从TypeScript 1.8之后的任何版本开始(或者如果您正在使用最前端的编译器,现在就开始),当类型的原始表达式是对象文字时,您将不再看到此错误。

请参阅https://github.com/Microsoft/TypeScript/pull/7029


旧编译器的旧答案

索引签名和对象文字在TypeScript中特别表现。从规范4.5节,对象文字:

  

当对象文字由包含a的类型进行上下文类型化时   类型为T的字符串索引签名,即对象的结果类型   literal包含一个带有扩展形式的字符串索引签名   最常见的T类型和在中声明的属性类型   object literal。

这一切意味着什么?

上下文打字

当表达式的 context 提供有关其类型的提示时,会发生上下文类型。例如,在此初始化中:

var x: number = y;

表达式y获取上下文类型number,因为它正在初始化该类型的值。在这种情况下,没有什么特别的事情发生,但在其他情况下会发生更有趣的事情。

最有用的案例之一是功能:

// Error: string does not contain a function called 'ToUpper'
var x: (n: string) => void = (s) => console.log(s.ToUpper());

编译器是如何知道s是字符串的?如果您自己编写了该函数表达式,s将是any类型,并且不会发出任何错误。但由于该函数是按照x的类型在上下文中键入,因此参数s获取了类型string。非常有用!

索引签名

索引签名指定对象按字符串或数字索引时的类型。当然,这些签名是类型检查的一部分:

var x: { [n: string]: Car; };
var y: { [n: string]: Animal; };
x = y; // Error: Cars are not Animals, this is invalid

缺少索引签名也很重要:

var x: { [n: string]: Car; };
var y: { name: Car; };
x = y; // Error: y doesn't have an index signature that returns a Car

希望上述两个片段显然应该导致错误。这导致我们......

索引签名和上下文键入

假设对象没有索引签名的问题是您无法初始化具有索引签名的对象:

var c: Car;
// Error, or not?
var x: { [n: string]: Car } = { 'mine': c };

解决方案是,当对象文字由具有索引签名的类型进行上下文类型化时,该索引签名将添加到对象文本的类型(如果匹配)。例如:

var c: Car;
var a: Animal;
// OK
var x: { [n: string]: Car } = { 'mine': c };
// Not OK: Animal is not Car
var y: { [n: string]: Car } = { 'mine': a };

全部放在一起

让我们看看问题中的原始函数:

function a(): StringMap {
    return { a: "1" }; // OK
}

确定,因为return语句中的表达式是由函数的返回类型进行上下文键入的。对象文字{a: "1"}的唯一属性具有字符串值,因此可以成功应用索引签名。

function b(): StringMap {
    var result: StringMap = { a: "1" };
    return result; // OK
}

确定,因为显式类型变量的初始值设定项是按变量类型进行上下文键入的。和以前一样,索引签名被添加到对象文字的类型中。

function c(): StringMap {
    var result = { a: "1" };
    return result; // Error - result lacks index signature, why?
}

不行,因为result的类型没有索引签名。