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