Firebase Realtime データベースのデータ スナップショットを表すインターフェイス。
サイン:
export declare class DataSnapshot implements database.DataSnapshot
実装: database.DataSnapshot
コンストラクター
コンストラクタ | 修飾子 | 説明 |
---|---|---|
(コンストラクター)(データ、パス、アプリ、インスタンス) | DataSnapshot クラスの新しいインスタンスを構築します |
プロパティ
財産 | 修飾子 | タイプ | 説明 |
---|---|---|---|
実例 | 弦 | ||
鍵 | 文字列 |ヌル | このDataSnapshot の場所のキー (パスの最後の部分)。データベースの場所にある最後のトークンがそのキーとみなされます。たとえば、「ada」は/users/ada/ ノードのキーです。 DataSnapshot 上のキーにアクセスすると、それを生成した場所のキーが返されます。ただし、データベースのルート URL のキーにアクセスすると、 null が返されます。 | |
参照 | データベース.リファレンス | トリガーとなる書き込みが発生したデータベースの場所に [ Reference ](/docs/reference/admin/node/admin.database.Reference) を返します。完全な読み取りおよび書き込みアクセス権があります。 |
メソッド
方法 | 修飾子 | 説明 |
---|---|---|
子(子パス) | 指定された相対パスの場所のDataSnapshot を取得します。相対パスは、単純な子名 (例: 「ada」) またはより深いスラッシュで区切られたパス (例: 「ada/name/first」) のいずれかです。 | |
存在します() | このDataSnapshot にデータが含まれている場合はtrue を返します。 snapshot.val() !== null を使用するよりもわずかに効率的です。このDataSnapshot にデータが含まれている場合はtrue 。それ以外の場合はfalse 。 | |
エクスポートVal() | DataSnapshot のコンテンツ全体を JavaScript オブジェクトとしてエクスポートします。 JavaScript 値としてのDataSnapshot の内容 (オブジェクト、配列、文字列、数値、ブール値、またはnull )。 | |
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 )。 |
データベース.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: IteratedDataSnapshot) => boolean | void): boolean;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
アクション | (a: IteratedDataSnapshot) => ブール値 |空所 | 子DataSnapshot ごとに呼び出される関数。コールバックはtrue を返して、さらなる列挙をキャンセルできます。 true を返すコールバックにより列挙がキャンセルされた場合はtrue 。 |
戻り値:
ブール値
データベース.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;
戻り値:
どれでも