Firebase Realtime Database のデータ スナップショットを表すインターフェース。
署名:
export declare class DataSnapshot implements database.DataSnapshot
実装: database.DataSnapshot
コンストラクタ
| コンストラクタ | 修飾キー | 説明 |
|---|---|---|
| (コンストラクタ)(データ, パス, アプリ, インスタンス) | DataSnapshot クラスの新しいインスタンスを作成します。 |
プロパティ
| プロパティ | 修飾キー | タイプ | 説明 |
|---|---|---|---|
| インスタンス | 文字列 | ||
| key | 文字列 |null | この DataSnapshot のロケーションのキー（パスの最後の部分）。データベースのロケーション内の最後のトークンがキーとみなされます。例: 「ada」/users/ada/ ノードのキーです。任意の DataSnapshot で鍵にアクセスすると、それを生成した場所の鍵が返されます。ただし、データベースのルート URL でキーにアクセスすると、null が返されます。 |
|
| 参照 | database.Reference | 書き込みをトリガーしたデータベースの場所への [Reference](/docs/reference/admin/node/admin.database.Reference) を返します。完全な読み取り / 書き込みアクセス権を持ちます。 |
メソッド
| メソッド | 修飾キー | 説明 |
|---|---|---|
| child(childPath) | 指定された相対パスにある場所の DataSnapshot を取得します。相対パスには、単純な子名（「ada」など）か、より深いスラッシュで区切られたパス（「ada/name/first」など）を使用できます。 |
|
| exists() | この DataSnapshot にデータが含まれている場合、true を返します。これは、snapshot.val() !== null を使用するよりも若干効率的です。この DataSnapshot にデータが含まれている場合は true、それ以外の場合は false です。 |
|
| exportVal() | DataSnapshot のコンテンツ全体を JavaScript オブジェクトとしてエクスポートします。JavaScript 値（オブジェクト、配列、文字列、数値、ブール値、null）で表される DataSnapshot のコンテンツ。 |
|
| forEach(アクション) | 子アイテムの DataSnapshot を列挙します。JavaScript オブジェクトの動作の性質上、val() によって返される JavaScript オブジェクト内のデータの順序は、サーバー上の順序や child_added イベントの順序と一致する保証はありません。このような場合に役立つのが forEach() です。DataSnapshot の子がクエリ順に反復処理されることが保証されます。明示的な orderBy*() メソッドを使用しない場合、結果はキー順に返されます（優先度が使用されている場合、結果は優先度によって返されます）。 |
|
| getPriority() | この DataSnapshot 内のデータの優先度値を取得します。優先度を使用する代わりに、アプリは通常のプロパティに基づいてコレクションを並べ替えることができます。[データの並べ替えとフィルタ](/docs/database/web/lists-of-data#sorting_and_filtering_data)をご覧ください。データの優先度の値。 |
|
| hasChild(childPath) | 指定された子パスに null 以外のデータがある場合、true を返します。 |
|
| hasChildren() | DataSnapshot に null 以外の子プロパティがあるかどうかを返します。hasChildren() を使用すると、DataSnapshot に子プロパティがあるかどうかを確認できます。存在する場合は、forEach() を使用して列挙できます。存在しない場合、このスナップショットにはプリミティブ値（val() で取得可能）が含まれているか、空（この場合、val() は null を返します）のいずれかになります。このスナップショットに子がある場合は true。でなければ false です。 |
|
| numChildren() | この DataSnapshot の子プロパティの数を返します。この DataSnapshot の子プロパティの数。 |
|
| toJSON() | このオブジェクトの JSON シリアル化可能な表現を返します。このオブジェクトの JSON シリアル化可能な表現。 | |
| val() | DataSnapshot から JavaScript 値を抽出します。DataSnapshot のデータに応じて、val() メソッドはスカラー型（文字列、数値、ブール値）、配列、またはオブジェクトを返します。また、DataSnapshot が空（データが含まれない）であることを示す null を返すこともできます。JavaScript 値（オブジェクト、配列、文字列、数値、ブール値、null）で表されるスナップショットの内容。 |
database.DataSnapshot.（コンストラクタ）
DataSnapshot クラスの新しいインスタンスを作成します。
署名:
constructor(data: any, path?: string, // path is undefined for the database root
app?: App, instance?: string);
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| データ | 任意 | |
| パス | 文字列 | |
| アプリ | アプリ | |
| インスタンス | 文字列 |
database.DataSnapshot.instance
署名:
instance: string;
database.DataSnapshot.key
この DataSnapshot の場所のキー（パスの最後の部分）。
データベース内の場所の最後のトークンがそのキーとみなされます。例: 「ada」/users/ada/ ノードのキーです。任意の DataSnapshot で鍵にアクセスすると、それを生成した場所の鍵が返されます。ただし、データベースのルート URL のキーにアクセスすると、null が返されます。
署名:
get key(): string | null;
database.DataSnapshot.ref
書き込みをトリガーしたデータベースの場所への [Reference](/docs/reference/admin/node/admin.database.Reference) を返します。完全な読み取り / 書き込みアクセス権を持ちます。
署名:
get ref(): database.Reference;
database.DataSnapshot.child()
指定された相対パスにあるロケーションの DataSnapshot を取得します。
相対パスには、単純な子名（「ada」など）か、より深いスラッシュで区切られたパス（「ada/name/first」など）を指定できます。
署名:
child(childPath: string): DataSnapshot;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| 子パス | 文字列 |
戻り値:
database.DataSnapshot.exists()
この DataSnapshot にデータが含まれている場合、true を返します。これは、snapshot.val() !== null を使用するよりも若干効率的です。
この DataSnapshot にデータが含まれている場合は true、それ以外の場合は false。
署名:
exists(): boolean;
戻り値:
ブール値
database.DataSnapshot.exportVal()
DataSnapshot のコンテンツ全体を JavaScript オブジェクトとしてエクスポートします。
JavaScript 値（オブジェクト、配列、文字列、数値、ブール値、null）で表される DataSnapshot のコンテンツ。
署名:
exportVal(): any;
戻り値:
任意
database.DataSnapshot.forEach()
子アイテムの DataSnapshot を列挙します。
JavaScript オブジェクトの動作の性質上、val() によって返される JavaScript オブジェクト内のデータの順序が、サーバー上の順序や child_added イベントの順序と一致するとは限りません。このような場合に役立つのが forEach() です。DataSnapshot の子をクエリ順序で反復処理できることを保証します。
明示的な orderBy*() メソッドが使用されていない場合、結果はキー順に返されます（優先度が使用されている場合、結果は優先度によって返されます）。
署名:
forEach(action: (a: DataSnapshot) => boolean | void): boolean;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| アクション | （a: DataSnapshot）=>ブール値 |無効 | 子 DataSnapshot ごとに呼び出される関数。このコールバックは true を返して、追加の列挙をキャンセルできます。true を返すコールバックによって列挙がキャンセルされた場合は true。 |
戻り値:
ブール値
database.DataSnapshot.getPriority()
この DataSnapshot 内のデータの優先度値を取得します。
優先度を使用する代わりに、アプリケーションは通常のプロパティでコレクションを並べ替えることができます。[データの並べ替えとフィルタ](/docs/database/web/lists-of-data#sorting_and_filtering_data)をご覧ください。
データの優先度の値。
署名:
getPriority(): string | number | null;
戻り値:
文字列 |数値 |null
database.DataSnapshot.hasChild()
指定された子パスに（null 以外の ）データがある場合、true を返します。
署名:
hasChild(childPath: string): boolean;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| 子パス | 文字列 |
戻り値:
ブール値
database.DataSnapshot.hasChildren()
DataSnapshot に null 以外の子プロパティがあるかどうかを返します。
hasChildren() を使用すると、DataSnapshot に子があるかどうかを判断できます。存在する場合は、forEach() を使用して列挙できます。存在しない場合、このスナップショットにはプリミティブ値（val() で取得可能）が含まれているか、空です（この場合、val() は null を返します）。
このスナップショットに子がある場合は true。else false。
署名:
hasChildren(): boolean;
戻り値:
ブール値
database.DataSnapshot.numChildren()
この DataSnapshot の子プロパティの数を返します。
この DataSnapshot の子プロパティの数。
署名:
numChildren(): number;
戻り値:
数値
database.DataSnapshot.toJSON()
このオブジェクトの JSON シリアル化可能な表現を返します。
このオブジェクトの JSON シリアル化可能な表現。
署名:
toJSON(): Record<string, unknown>;
戻り値:
レコード <文字列、不明>
database.DataSnapshot.val()
DataSnapshot から JavaScript 値を抽出します。
DataSnapshot 内のデータに応じて、val() メソッドはスカラー型（文字列、数値、ブール値）、配列、またはオブジェクトを返します。また、DataSnapshot が空（データが含まれない）であることを示す null を返すこともできます。
JavaScript 値（オブジェクト、配列、文字列、数値、ブール値、null）で表されるスナップショットの内容。
署名:
val(): any;
戻り値:
任意