database.DataSnapshot class

Firebase Realtime データベースのデータ スナップショットを表すインターフェイス。

サイン：

export declare class DataSnapshot implements database.DataSnapshot 

実装: database.DataSnapshot

コンストラクター

プロパティ

メソッド

データベース.DataSnapshot.(コンストラクター)

DataSnapshotクラスの新しいインスタンスを構築します

サイン：

constructor(data: any, path?: string, // path is undefined for the database root
    app?: App, instance?: string);

パラメーター

データベース.DataSnapshot.instance

サイン：

instance: string;

データベース.DataSnapshot.key

このDataSnapshotの場所のキー (パスの最後の部分) 。

データベースの場所にある最後のトークンがそのキーとみなされます。たとえば、「ada」は/users/ada/ノードのキーです。 DataSnapshot上のキーにアクセスすると、それを生成した場所のキーが返されます。ただし、データベースのルート URL のキーにアクセスするとnullが返されます。 。

サイン：

get key(): string | null;

データベース.DataSnapshot.ref

[ Referenceを返します。 ](/docs/reference/admin/node/admin.database.Reference) を、トリガーとなる書き込みが発生したデータベースの場所にコピーします。完全な読み取りおよび書き込みアクセス権があります。

サイン：

get ref(): database.Reference;

データベース.DataSnapshot.child()

指定された相対パスの場所のDataSnapshotを取得します。

相対パスは、単純な子名 (例: 「ada」) またはより深いスラッシュで区切られたパス (例: 「ada/name/first」) のいずれかです。

サイン：

child(childPath: string): DataSnapshot;

パラメーター

戻り値：

データスナップショット

データベース.DataSnapshot.exists()

このDataSnapshotにデータが含まれている場合はtrueを返します。 snapshot.val() !== null 。

このDataSnapshotにデータが含まれている場合はtrue 。それ以外の場合はfalse 。

サイン：

exists(): boolean;

戻り値：

ブール値

データベース.DataSnapshot.exportVal()

DataSnapshotのコンテンツ全体を JavaScript オブジェクトとしてエクスポートします。

JavaScript 値としてのDataSnapshotの内容 (オブジェクト、配列、文​​字列、数値、ブール値、またはnull ）。

サイン：

exportVal(): any;

戻り値：

どれでも

データベース.DataSnapshot.forEach()

DataSnapshotを列挙します子アイテムの s。

JavaScript オブジェクトの動作方法のため、 val()によって返される JavaScript オブジェクト内のデータの順序は、サーバー上の順序やchild_addedイベントの順序と一致することが保証されません。そこでforEach()役に立ちます。これにより、 DataSnapshotの子がクエリ順序で反復できることが保証されます。

明示的なorderBy*()メソッドが使用されていない場合、結果はキー順に返されます (優先順位が使用されない限り、その場合、結果は優先順位に従って返されます)。

サイン：

forEach(action: (a: DataSnapshot) => boolean | void): boolean;

パラメーター

戻り値：

ブール値

データベース.DataSnapshot.getPriority()

このDataSnapshot内のデータの優先度の値を取得します。

優先順位を使用する代わりに、アプリケーションは通常のプロパティによってコレクションを順序付けることができます。 [データの並べ替えとフィルター](/docs/database/web/lists-of-data#sorting_and_filtering_data) を参照してください。

データの優先度の値。

サイン：

getPriority(): string | number | null;

戻り値：

文字列 |番号 |ヌル

データベース.DataSnapshot.hasChild()

指定された子パスに ( null以外の) がある場合はtrueを返します。 ） データ。

サイン：

hasChild(childPath: string): boolean;

パラメーター

戻り値：

ブール値

データベース.DataSnapshot.hasChildren()

DataSnapshotにnull以外の子プロパティがあるかどうかを返します。

hasChildren()を使用すると、 DataSnapshot子があるかどうかを判断できます。存在する場合は、 forEach()を使用してそれらを列挙できます。 。そうでない場合は、このスナップショットにはプリミティブ値 ( val()が含まれています。 ) または空です (この場合、 val()はnullを返します) ）。

このスナップショットに子がある場合はtrue 。それ以外の場合はfalse 。

サイン：

hasChildren(): boolean;

戻り値：

ブール値

データベース.DataSnapshot.numChildren()

このDataSnapshotの子プロパティの数を返します。 。

このDataSnapshotの子プロパティの数。

サイン：

numChildren(): number;

戻り値：

番号

データベース.DataSnapshot.toJSON()

このオブジェクトの JSON シリアル化可能な表現を返します。

このオブジェクトの JSON シリアル化可能な表現。

サイン：

toJSON(): Record<string, unknown>;

戻り値：

レコード<文字列、不明>

データベース.DataSnapshot.val()

DataSnapshotから JavaScript 値を抽出します。

DataSnapshot内のデータに応じてval()メソッドは、スカラー型 (文字列、数値、またはブール値)、配列、またはオブジェクトを返す場合があります。 nullを返すこともあります、 DataSnapshot空である (データが含まれていない) ことを示します。

JavaScript 値としてのスナップショットの内容 (オブジェクト、配列、文​​字列、数値、ブール値、またはnull ）。

サイン：

val(): any;

戻り値：

どれでも