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