flow中文文档(四)

在JavaScript中,对象可以以多种不同的方式使用。为了支持所有不同的用例,有许多不同的方法可以输入它们。

对象类型语法

对象类型尽可能地尝试匹配JavaScript中对象的语法。使用冒号使用花括号{}和名称 - 值对:用逗号分隔,。

// @flow
var obj1: { foo: boolean } = { foo: true };
var obj2: {
  foo: number,
  bar: boolean,
  baz: string,
} = {
  foo: 1,
  bar: true,
  baz: 'three',
};

注意:以前的对象类型使用分号;用于拆分名称 - 值对。虽然语法仍然有效,但您应该使用逗号,

可选对象类型属性

在JavaScript中,访问不存在的属性的计算结果为undefined。这是JavaScript程序中常见的错误来源,因此Flow将这些错误转换为类型错误。

// @flow
var obj = { foo: "bar" };
// $ExpectError
obj.bar; // Error!  cannot get `obj.bar` beacuse property `bar` is missing in object litera [1].

如果您有一个有时没有属性的对象,可以通过在对象类型中的属性名称之后添加问号使其成为可选属性。

// @flow
var obj: { foo?: boolean } = {};

obj.foo = true;    // Works!
// $ExpectError
obj.foo = 'hello'; // Error! cannot assign `'hello'` to `obj.foo` because string [1] is incomptible with boolean [2]

除了它们的设置值类型之外,这些可选属性可以是 void,也可以完全省略。但是,它们不能为 null。

// @flow
function acceptsObject(value: { foo?: string }) {
  // ...
}

acceptsObject({ foo: "bar" });     // Works!
acceptsObject({ foo: undefined }); // Works!
// $ExpectError
acceptsObject({ foo: null });      // Error!
acceptsObject({});                 // Works!

密封对象

使用其属性创建对象时,可在Flow中创建密封对象类型。这些密封对象将知道您声明它们的所有属性及其值的类型。

// @flow
var obj = {
  foo: 1,
  bar: true,
  baz: 'three'
};

var foo: number  = obj.foo; // Works!
var bar: boolean = obj.bar; // Works!
// $ExpectError
var baz: null    = obj.baz; // Error!
var bat: string  = obj.bat; // Error!

但是当对象被密封时,Flow将不允许您向它们添加新属性。

// @flow
var obj = {
  foo: 1
};

// $ExpectError
obj.bar = true;    // Error!
// $ExpectError
obj.baz = 'three'; // Error!

此处的解决方法可能是将您的对象转换为未密封的对象。

未密封对象

创建没有任何属性的对象时,可以在Flow中创建未密封的对象类型。这些未密封的对象不会知道它们的所有属性,并允许您添加新属性。

// @flow
var obj = {};

obj.foo = 1;       // Works!
obj.bar = true;    // Works!
obj.baz = 'three'; // Works!

属性的推断类型(类型注释)将成为您设置的属性。

重新分配未密封的对象属性

类似于var和let变量,如果重新分配未密封对象的属性,默认情况下,Flow会为其指定所有可能分配的类型。

// @flow
var obj = {};

if (Math.random()) obj.prop = true;
else obj.prop = "hello";

// $ExpectError
var val1: boolean = obj.prop; // Error!
// $ExpectError
var val2: string  = obj.prop; // Error!
var val3: boolean | string = obj.prop; // Works!

有时,Flow能够在重新分配后(确定地)确定属性的类型。在这种情况下,Flow将为其提供已知类型。

// @flow
var obj = {};

obj.prop = true;
obj.prop = "hello";

// $ExpectError
var val1: boolean = obj.prop; // Error!
var val2: string  = obj.prop; // Works!

随着Flow变得越来越聪明,它将在更多场景中找出属性的类型。

未密封对象上的未知属性查找是不安全的

未密封的对象允许随时写入新属性。 Flow确保读取与写入兼容,但不确保在读取之前发生写入(按执行顺序)。

这意味着永远不会检查没有匹配写入的未密封对象的读取。这是Flow的一种不安全行为,将来可能会得到改善。

var obj = {};

obj.foo = 1;
obj.bar = true;

var foo: number  = obj.foo; // Works!
var bar: boolean = obj.bar; // Works!
var baz: string  = obj.baz; // Works?

精确对象类型

在Flow中,传递具有额外属性的对象被认为是安全的,其中期望正常的对象类型。

// @flow
function method(obj: { foo: string }) {
  // ...
}

method({
  foo: "test", // Works!
  bar: 42      // Works!
});

有时禁用此行为并仅允许一组特定属性很有用。为此,Flow支持“精确”对象类型。

{| foo: string, bar: number |}

与常规对象类型不同,将具有“额外”属性的对象传递给精确对象类型无效。

// @flow
var foo: {| foo: string |} = { foo: "Hello", bar: "World!" }; // Error!

确切对象类型的交集可能无法按预期工作。如果需要组合确切的对象类型,请使用对象类型传播:

// @flow

type FooT = {| foo: string |};
type BarT = {| bar: number |};

type FooBarFailT = FooT & BarT;
type FooBarT = {| ...FooT, ...BarT |};

const fooBarFail: FooBarFailT = { foo: '123', bar: 12 }; // Error!
const fooBar: FooBarT = { foo: '123', bar: 12 }; // Works!

ObjectsAsMaps

较新版本的JavaScript标准包含一个Map类,但将对象用作Maps仍然很常见。在此用例中,对象可能会添加属性并在其整个生命周期中检索。此外,属性键甚至可能不是静态已知的,因此写出类型注释是不可能的。

对于像这样的对象,Flow提供了一种特殊的属性,称为“索引器属性”。索引器属性允许使用与索引器键类型匹配的任何键进行读写。

// @flow
var o: { [string]: number } = {};
o["foo"] = 0;
o["bar"] = 1;
var foo: number = o["foo"];

可以选择命名索引器,以用于文档目的:

// @flow
var obj: { [user_id: number]: string } = {};
obj[1] = "Julia";
obj[2] = "Camille";
obj[3] = "Justin";
obj[4] = "Mark";

当对象类型具有索引器属性时,假定属性访问具有带注释的类型,即使该对象在运行时没有该槽中的值。程序员有责任确保访问是安全的,就像数组一样。

var obj: { [number]: string } = {};
obj[42].length; //没有类型错误,但会在运行时抛出

索引器属性可以与命名属性混合使用:

// @flow
var obj: {
  size: number,
  [id: number]: string
} = {
  size: 0
};

function add(id: number, name: string) {
  obj[id] = name;
  obj.size++;
}

Object Type

有时编写接受任意对象的类型是有用的,对于那些你应该写{}的类似:

function method(obj: {}) {
  // ...
}

但是,如果您需要选择退出类型检查程序,并且不想一直转到任何类型检查程序,则可以改为使用Object。Object 不安全,应该避免。

例如,以下代码不会报告任何错误:

function method(obj: Object) {
  obj.foo = 42;               // Works.
  let bar: boolean = obj.bar; // Works.
  obj.baz.bat.bam.bop;        // Works.
}

method({ baz: 3.14, bar: "hello" });
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,711评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,079评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,194评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,089评论 1 286
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,197评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,306评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,338评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,119评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,541评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,846评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,014评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,694评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,322评论 3 318
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,026评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,257评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,863评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,895评论 2 351

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,644评论 18 139
  • 关于Mongodb的全面总结 MongoDB的内部构造《MongoDB The Definitive Guide》...
    中v中阅读 31,916评论 2 89
  • 【日更166】 这两天在网上看到一部短片《下一个十年,你会在哪里?》,剧情是爷孙俩一起跑步,然后小孙女嫌弃刚毕业的...
    唐斩2086阅读 1,095评论 0 1