FieldPath
是指文档中的字段。路径可以由单个字段名称(引用文档中的顶级字段)或一系列字段名称(引用文档中的嵌套字段)组成。
通过提供字段名称来创建 FieldPath
。如果提供了多个字段名称,则路径将指向文档中的嵌套字段。
签名:
export declare class FieldPath
构造函数
构造函数 | 修饰符 | 说明 |
---|---|---|
(构造函数)(fieldNames) | 根据提供的字段名称创建 FieldPath 。如果提供了多个字段名称,则路径将指向文档中的嵌套字段。 |
方法
方法 | 修饰符 | 说明 |
---|---|---|
isEqual(other) | 如果此 FieldPath 等于提供的值,则返回 true。 |
FieldPath.(构造函数)
根据提供的字段名称创建 FieldPath
。如果提供了多个字段名称,则路径将指向文档中的嵌套字段。
签名:
constructor(...fieldNames: string[]);
参数
参数 | 类型 | 说明 |
---|---|---|
字段名称 | 字符串[] | 字段名称列表。 |
FieldPath.isEqual()
如果此 FieldPath
等于提供的值,则返回 true。
签名:
isEqual(other: FieldPath): boolean;
参数
参数 | 类型 | 说明 |
---|---|---|
其他 | FieldPath | 要比较的 FieldPath 。 |
返回:
布尔值
如果此 FieldPath
等于提供的值,则为 true。