FieldPath class

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。