FieldPath
はドキュメント内のフィールドを参照します。パスは、単一のフィールド名(ドキュメント内の最上位フィールドを参照)にすることも、フィールド名のリスト(ドキュメント内のネストされたフィールドを参照)で構成することもできます。
フィールド名を指定して FieldPath
を作成します。複数のフィールド名が指定されている場合、パスはドキュメント内のネストされたフィールドを指します。
署名:
export declare class FieldPath
コンストラクタ
コンストラクタ | 修飾キー | 説明 |
---|---|---|
(コンストラクタ)(fieldNames) | 指定されたフィールド名から FieldPath を作成します。複数のフィールド名が指定されている場合、パスはドキュメント内のネストされたフィールドを指します。 |
メソッド
メソッド | 修飾キー | 説明 |
---|---|---|
isEqual(other) | この FieldPath が指定された値と等しい場合、true を返します。 |
FieldPath.(コンストラクタ)
指定されたフィールド名から FieldPath
を作成します。複数のフィールド名が指定されている場合、パスはドキュメント内のネストされたフィールドを指します。
署名:
constructor(...fieldNames: string[]);
パラメータ
パラメータ | 型 | 説明 |
---|---|---|
fieldNames | string[] | フィールド名のリスト。 |
FieldPath.isEqual()
この FieldPath
が指定された値と等しい場合、true を返します。
署名:
isEqual(other: FieldPath): boolean;
パラメータ
パラメータ | 型 | 説明 |
---|---|---|
その他 | FieldPath | 比較対象の FieldPath 。 |
戻り値:
ブール値
この FieldPath
が指定された値と等しい場合は true を返します。