DataSnapshot
は、データベースの場所からのデータが含まれています。
データベースからデータを読み取るたびに、データをDataSnapshot
として受け取ります。 。 DataSnapshot
on()
またはonce()
でアタッチしたイベント コールバックに渡されます。 。 val()
メソッドを呼び出すことで、スナップショットの内容を JavaScript オブジェクトとして抽出できます。あるいは、 child()
を呼び出して子スナップショットを返すことによって、スナップショットにアクセスすることもできます (その後、 val()
を呼び出すことができます)。
DataSnapshot
は、データベースの場所にある、効率的に生成されたデータの不変のコピーです。これは変更できず、決して変更されません (データを変更するには、常にReference
のset()
メソッドを直接呼び出します)。
サイン:
export declare class DataSnapshot
プロパティ
財産 | 修飾子 | タイプ | 説明 |
---|---|---|---|
鍵 | 文字列 |ヌル | このDataSnapshot の場所のキー (パスの最後の部分)。データベースの場所にある最後のトークンがそのキーとみなされます。たとえば、「ada」は /users/ada/ ノードのキーです。 DataSnapshot 上のキーにアクセスすると、それを生成した場所のキーが返されます。ただし、データベースのルート URL のキーにアクセスすると、 null が返されます。 | |
優先度 | 文字列 |番号 |ヌル | このDataSnapshot 内のデータの優先度の値を取得します。アプリケーションは優先順位を使用する必要はありませんが、通常のプロパティによってコレクションを順序付けることができます (データの並べ替えとフィルター処理を参照)。 | |
参照 | データベースリファレンス | この DataSnapshot の場所。 | |
サイズ | 番号 | このDataSnapshot の子プロパティの数を返します。 |
メソッド
方法 | 修飾子 | 説明 |
---|---|---|
子(パス) | 指定された相対パスの場所の別のDataSnapshot を取得します。 DataSnapshot のchild() メソッドに相対パスを渡すと、指定された相対パスの場所に別のDataSnapshot が返されます。相対パスは、単純な子名 (「ada」など) またはスラッシュで区切られたより深いパス (「ada/name/first」など) のいずれかになります。子の場所にデータがない場合は、空のDataSnapshot (つまり、値がnull のDataSnapshot ) が返されます。 | |
存在します() | このDataSnapshot にデータが含まれている場合は true を返します。 snapshot.val() !== null を使用するよりもわずかに効率的です。 | |
エクスポートVal() | DataSnapshot のコンテンツ全体を JavaScript オブジェクトとしてエクスポートします。 exportVal() メソッドはval() に似ていますが、優先度情報が含まれている点が異なります (利用可能な場合)。データのバックアップに適しています。 | |
forEach(アクション) | IteratedDataSnapshot の最上位の子を列挙します。 JavaScript オブジェクトの動作方法のため、 val() によって返される JavaScript オブジェクト内のデータの順序は、サーバー上の順序やonChildAdded() イベントの順序と一致することが保証されません。そこでforEach() 役に立ちます。これによりDataSnapshot の子がクエリ順序で反復されることが保証されます。明示的なorderBy*() メソッドが使用されていない場合、結果はキー順に返されます (優先順位が使用されない限り、その場合、結果は優先順位に従って返されます)。 | |
hasChild(パス) | 指定された子パスに (null 以外の) データがある場合は true を返します。 | |
hasChildren() | DataSnapshot にnull 以外の子プロパティがあるかどうかを返します。 hasChildren() を使用すると、 DataSnapshot 子があるかどうかを判断できます。存在する場合は、 forEach() を使用してそれらを列挙できます。そうでない場合は、このスナップショットにはプリミティブ値 ( val() で取得できる) が含まれているか、空である (この場合、 val() はnull を返します) のいずれかです。 | |
toJSON() | このオブジェクトの JSON シリアル化可能な表現を返します。 | |
val() | DataSnapshot から JavaScript 値を抽出します。 DataSnapshot 内のデータに応じて、 val() メソッドはスカラー型 (文字列、数値、またはブール値)、配列、またはオブジェクトを返す場合があります。また、 DataSnapshot 空である (データが含まれていない) ことを示す null を返す場合もあります。 |
DataSnapshot.key
このDataSnapshot
の場所のキー (パスの最後の部分) 。
データベースの場所にある最後のトークンがそのキーとみなされます。たとえば、「ada」は /users/ada/ ノードのキーです。 DataSnapshot
上のキーにアクセスすると、それを生成した場所のキーが返されます。ただし、データベースのルート URL のキーにアクセスするとnull
が返されます。 。
サイン:
get key(): string | null;
DataSnapshot.priority
このDataSnapshot
内のデータの優先度の値を取得します。
アプリケーションは優先順位を使用する必要はありませんが、通常のプロパティによってコレクションを順序付けることができます (データの並べ替えとフィルター処理を参照)。
サイン:
get priority(): string | number | null;
データスナップショット.ref
この DataSnapshot の場所。
サイン:
readonly ref: DatabaseReference;
DataSnapshot.size
このDataSnapshot
の子プロパティの数を返します。 。
サイン:
get size(): number;
DataSnapshot.child()
指定された相対パスの場所の別のDataSnapshot
を取得します。
DataSnapshot のchild()
メソッドに相対パスを渡すと、指定された相対パスの場所に別のDataSnapshot
が返されます。相対パスは、単純な子名 (「ada」など) またはスラッシュで区切られたより深いパス (「ada/name/first」など) のいずれかになります。子の場所にデータがない場合は、空のDataSnapshot
(値がnull
のDataSnapshot
)が返されます。
サイン:
child(path: string): DataSnapshot;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
パス | 弦 | 子データの場所への相対パス。 |
戻り値:
DataSnapshot.exists()
このDataSnapshot
にデータが含まれている場合は true を返します。 snapshot.val() !== null
。
サイン:
exists(): boolean;
戻り値:
ブール値
DataSnapshot.exportVal()
DataSnapshot のコンテンツ全体を JavaScript オブジェクトとしてエクスポートします。
exportVal()
メソッドはval()
に似ています。ただし、優先情報が含まれているため (利用可能な場合)、データのバックアップに適しています。
サイン:
exportVal(): any;
戻り値:
どれでも
JavaScript 値としての DataSnapshot の内容 (オブジェクト、配列、文字列、数値、ブール値、またはnull
)。
DataSnapshot.forEach()
IteratedDataSnapshot
の最上位の子を列挙します。 。
JavaScript オブジェクトの動作方法のため、 val()
によって返される JavaScript オブジェクト内のデータの順序は、サーバー上の順序やonChildAdded()
イベントの順序と一致することが保証されません。そこでforEach()
役に立ちます。これによりDataSnapshot
の子がクエリ順序で反復されることが保証されます。
明示的なorderBy*()
メソッドが使用されていない場合、結果はキー順に返されます (優先順位が使用されない限り、その場合、結果は優先順位に従って返されます)。
サイン:
forEach(action: (child: IteratedDataSnapshot) => boolean | void): boolean;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
アクション | (子: IteratedDataSnapshot ) => ブール値 |空所 | 各子 DataSnapshot に対して呼び出される関数。コールバックは true を返して、さらなる列挙をキャンセルできます。 |
戻り値:
ブール値
true を返すコールバックにより列挙がキャンセルされた場合は true。
DataSnapshot.hasChild()
指定された子パスに (null 以外の) データがある場合は true を返します。
サイン:
hasChild(path: string): boolean;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
パス | 弦 | 潜在的な子の位置への相対パス。 |
戻り値:
ブール値
指定された子パスにデータが存在する場合はtrue
。それ以外の場合はfalse
。
DataSnapshot.hasChildren()
DataSnapshot
にnull
以外の子プロパティがあるかどうかを返します。
hasChildren()
を使用すると、 DataSnapshot
子があるかどうかを判断できます。存在する場合は、 forEach()
を使用してそれらを列挙できます。 。そうでない場合は、このスナップショットにはプリミティブ値 ( val()
が含まれています。 ) または空です (この場合、 val()
null
を返します) )。
サイン:
hasChildren(): boolean;
戻り値:
ブール値
このスナップショットに子がある場合は true 。それ以外の場合は偽です。
DataSnapshot.toJSON()
このオブジェクトの JSON シリアル化可能な表現を返します。
サイン:
toJSON(): object | null;
戻り値:
オブジェクト |ヌル
DataSnapshot.val()
DataSnapshot
から JavaScript 値を抽出します。
DataSnapshot
内のデータに応じてval()
メソッドは、スカラー型 (文字列、数値、またはブール値)、配列、またはオブジェクトを返す場合があります。また、 DataSnapshot
空である (データが含まれていない) ことを示す null を返す場合もあります。
サイン:
val(): any;
戻り値:
どれでも
JavaScript 値としての DataSnapshot の内容 (オブジェクト、配列、文字列、数値、ブール値、またはnull
)。