database package

Firebase リアルタイム データベース

機能

関数説明
関数(アプリ、...)
getDatabase(アプリ, URL)提供されたFirebaseAppに関連付けられている Realtime Database SDK のインスタンスを返します。 。インスタンスが存在しない場合、または既存のインスタンスがカスタム データベース URL を使用している場合は、デフォルト設定で新しいインスタンスを初期化します。
関数(db, ...)
connectDatabaseEmulator(データベース、ホスト、ポート、オプション) Realtime Database エミュレーターと通信するように、提供されたインスタンスを変更します。

注: このメソッドは、他の操作を実行する前に呼び出す必要があります。

オフラインにする(データベース)サーバーから切断します (すべてのデータベース操作はオフラインで完了します)。クライアントはデータベース サーバーへの永続的な接続を自動的に維持します。これは無期限にアクティブな状態を維持し、切断されると再接続します。ただし、永続的な接続が望ましくない場合は、 goOffline()メソッドとgoOnline()メソッドを使用してクライアント接続を制御することができます。オフラインの間、クライアントはデータベースからデータ更新を受信しなくなります。ただし、ローカルで実行されるすべてのデータベース操作は引き続きイベントを即座に起動するため、アプリケーションは通常どおり動作し続けることができます。さらに、ローカルで実行される各操作は自動的にキューに入れられ、データベース サーバーへの再接続時に再試行されます。データベースに再接続してリモート イベントの受信を開始するには、 goOnline()を参照してください。
ゴーオンライン(データベース)サーバーに再接続し、オフラインのデータベース状態をサーバーの状態と同期します。このメソッドは、 goOffline()でアクティブな接続を無効にした後に使用する必要があります。再接続すると、クライアントは適切なデータを送信し、適切なイベントを起動して、クライアントが自動的に「追いつく」ようにします。
ref(データベース、パス)指定されたパスに対応するデータベース内の場所を表すReferenceを返します。パスが指定されていない場合、 Referenceデータベースのルートを指します。
refFromURL(db, URL)指定された Firebase URL に対応するデータベース内の場所を表すReferenceを返します。 URL が有効な Firebase データベース URL でない場合、または現在のDatabaseインスタンスとは異なるドメインがある場合は、例外がスローされます。すべてのクエリ パラメーター ( orderBylimitToLastなど) は無視され、返されたReferenceには適用されないことに注意してください。
関数()
ForceLongPolling() WebSocket の代わりに longPolling の使用を強制します。 DatabaseURL で WebSocket プロトコルが使用されている場合、これは無視されます。
ForceWebSockets() longPolling の代わりに WebSocket の使用を強制します。
orderByKey()キーによって順序付けする新しいQueryConstraintを作成します。クエリの結果を (昇順) キー値で並べ替えます。 orderByKey()の詳細については、 「データの並べ替え」を参照してください。
orderByPriority()優先順位に従って順序付けする新しいQueryConstraintを作成します。アプリケーションは優先順位を使用する必要はありませんが、通常のプロパティによってコレクションを並べ替えることができます (優先順位の代替手段については、 「データの並べ替え」を参照してください)。
orderByValue()値で順序付けする新しいQueryConstraintを作成します。クエリの子がすべてスカラー値 (文字列、数値、またはブール値) である場合、結果をその値 (昇順) で並べ替えることができます。 orderByValue()の詳細については、「データの並べ替え」を参照してください。
サーバータイムスタンプ() Firebase サーバーによって決定された現在のタイムスタンプ (Unix エポックからの時間、ミリ秒単位) を自動入力するためのプレースホルダー値を返します。
関数(デルタ, ...)
増分(デルタ)指定されたデルタによって現在のデータベース値をアトミックにインクリメントするために使用できるプレースホルダー値を返します。
機能(有効、...)
EnableLogging(有効、永続)デバッグ情報をコンソールに記録します。
関数(制限, ...)
最初までの制限(制限)最初の特定の数の子に制限される場合は、新しいQueryConstraintを作成します。 limitToFirst()メソッドは、特定のコールバックに対して同期される子の最大数を設定するために使用されます。制限を 100 に設定すると、最初は最大 100 個のchild_addedイベントのみを受け取ります。データベースに保存されているメッセージが 100 件未満の場合、メッセージごとにchild_addedイベントが発生します。ただし、メッセージが 100 を超える場合は、順序付けされた最初の 100 メッセージについてのみchild_addedイベントを受け取ります。アイテムが変更されると、合計数が 100 に留まるように、アクティブ リストからドロップされるアイテムごとにchild_removedイベントを受け取ります。 limitToFirst()の詳細については、 「データのフィルタリング」を参照してください。
最後までの制限(制限)最後に指定された数の子のみを返すように制限された新しいQueryConstraintを作成します。 limitToLast()メソッドは、特定のコールバックに対して同期される子の最大数を設定するために使用されます。制限を 100 に設定すると、最初は最大 100 個のchild_addedイベントのみを受け取ります。データベースに保存されているメッセージが 100 件未満の場合、メッセージごとにchild_addedイベントが発生します。ただし、メッセージが 100 を超える場合は、順序付けされた最後の 100 メッセージに対するchild_addedイベントのみを受け取ります。アイテムが変更されると、合計数が 100 に留まるように、アクティブ リストからドロップされるアイテムごとにchild_removedイベントを受け取ります。 limitToLast()の詳細については、 「データのフィルタリング」を参照してください。
関数(ロガー、...)
EnableLogging(ロガー)デバッグ情報をコンソールに記録します。
関数(親, ...)
子(親、パス)指定された相対パスの場所のReferenceを取得します。相対パスは、単純な子名 (例: 「ada」) またはより深いスラッシュで区切られたパス (例: 「ada/name/first」) のいずれかです。
プッシュ(親, 値)一意のキーを使用して新しい子の場所を生成し、そのReferenceを返します。これは、項目のコレクションにデータを追加する最も一般的なパターンです。 push()に値を指定すると、その値は生成された場所に書き込まれます。値を渡さない場合、データベースには何も書き込まれず、子は空のままになります (ただし、 Reference他の場所で使用できます)。 push()によって生成された一意のキーは現在の時間順に並べられるため、結果として得られる項目のリストは時系列に並べ替えられます。キーはまた、推測できないように設計されています (キーには 72 ランダム ビットのエントロピーが含まれています)。データのリストへの追加を参照してください。一意の識別子を確保する 2^120 の方法を参照してください。
関数(パス, ...)
orderByChild(パス)指定された子キーによって順序付けされる新しいQueryConstraintを作成します。クエリは一度に 1 つのキーでのみ順序付けできます。同じクエリに対してorderByChild()を複数回呼び出すとエラーになります。 Firebase クエリを使用すると、その場で任意の子キーによってデータを並べ替えることができます。ただし、インデックスが何になるかを事前に知っている場合は、パフォーマンスを向上させるために、セキュリティ ルールの .indexOn ルールを使用してインデックスを定義できます。詳細については、 https://firebase.google.com/docs/database/security/indexing-dataルールを参照してください。 orderByChild()の詳細については、 「データの並べ替え」を参照してください。
関数(クエリ、...)
取得(クエリ)このクエリの最新の結果を取得します。
off(クエリ、イベントタイプ、コールバック)対応するon () ( onValueonChildAdded ) リスナーで以前にアタッチされたコールバックをデタッチします。注: これは、リスナーを削除する推奨される方法ではありません。代わりに、それぞれのonバックから返されたコールバック関数を使用してください。以前にon*()でアタッチされたコールバックをデタッチします。親リスナーでoff()を呼び出しても、子ノードに登録されているリスナーは自動的に削除されません。コールバックを削除するには、子リスナーでもoff()を呼び出す必要があります。コールバックが指定されていない場合、指定されたeventTypeのすべてのコールバックが削除されます。同様に、eventType が指定されていない場合、 Referenceのすべてのコールバックが削除されます。個々のリスナーは、購読解除コールバックを呼び出して削除することもできます。
onChildAdded(クエリ、コールバック、cancelCallback)特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る主な方法です。コールバックは初期データに対してトリガーされ、データが変更されるたびに再度トリガーされます。返された購読解除コールバックを呼び出して、更新の受信を停止します。詳細については、「Web 上のデータの取得」を参照してください。 onChildAddedイベントは、この場所の最初の子ごとに 1 回トリガーされ、新しい子が追加されるたびに再度トリガーされます。コールバックに渡されるDataSnapshotには、関連する子のデータが反映されます。順序付けの目的で、ソート順による前の兄弟の子のキーを含む文字列である 2 番目の引数が渡されます。最初の子の場合はnullです。
onChildAdded(クエリ、コールバック、オプション)特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る主な方法です。コールバックは初期データに対してトリガーされ、データが変更されるたびに再度トリガーされます。返された購読解除コールバックを呼び出して、更新の受信を停止します。詳細については、「Web 上のデータの取得」を参照してください。 onChildAddedイベントは、この場所の最初の子ごとに 1 回トリガーされ、新しい子が追加されるたびに再度トリガーされます。コールバックに渡されるDataSnapshotには、関連する子のデータが反映されます。順序付けの目的で、ソート順による前の兄弟の子のキーを含む文字列である 2 番目の引数が渡されます。最初の子の場合はnullです。
onChildAdded(クエリ、コールバック、cancelCallback、オプション)特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る主な方法です。コールバックは初期データに対してトリガーされ、データが変更されるたびに再度トリガーされます。返された購読解除コールバックを呼び出して、更新の受信を停止します。詳細については、「Web 上のデータの取得」を参照してください。 onChildAddedイベントは、この場所の最初の子ごとに 1 回トリガーされ、新しい子が追加されるたびに再度トリガーされます。コールバックに渡されるDataSnapshotには、関連する子のデータが反映されます。順序付けの目的で、ソート順による前の兄弟の子のキーを含む文字列である 2 番目の引数が渡されます。最初の子の場合はnullです。
onChildChanged(クエリ、コールバック、cancelCallback)特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る主な方法です。コールバックは初期データに対してトリガーされ、データが変更されるたびに再度トリガーされます。返された購読解除コールバックを呼び出して、更新の受信を停止します。詳細については、「Web 上のデータの取得」を参照してください。 onChildChangedイベントは、子 (またはその子孫) に格納されているデータが変更されるとトリガーされます。 1 つのchild_changedイベントが子に対する複数の変更を表す場合があることに注意してください。コールバックに渡されるDataSnapshotには、新しい子のコンテンツが含まれます。順序付けの目的で、コールバックには 2 番目の引数も渡されます。これは、ソート順による前の兄弟の子のキーを含む文字列、または最初の子の場合はnullです。
onChildChanged(クエリ、コールバック、オプション)特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る主な方法です。コールバックは初期データに対してトリガーされ、データが変更されるたびに再度トリガーされます。返された購読解除コールバックを呼び出して、更新の受信を停止します。詳細については、「Web 上のデータの取得」を参照してください。 onChildChangedイベントは、子 (またはその子孫) に格納されているデータが変更されるとトリガーされます。 1 つのchild_changedイベントが子に対する複数の変更を表す場合があることに注意してください。コールバックに渡されるDataSnapshotには、新しい子のコンテンツが含まれます。順序付けの目的で、コールバックには 2 番目の引数も渡されます。これは、ソート順による前の兄弟の子のキーを含む文字列、または最初の子の場合はnullです。
onChildChanged(クエリ、コールバック、cancelCallback、オプション)特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る主な方法です。コールバックは初期データに対してトリガーされ、データが変更されるたびに再度トリガーされます。返された購読解除コールバックを呼び出して、更新の受信を停止します。詳細については、「Web 上のデータの取得」を参照してください。 onChildChangedイベントは、子 (またはその子孫) に格納されているデータが変更されるとトリガーされます。 1 つのchild_changedイベントが子に対する複数の変更を表す場合があることに注意してください。コールバックに渡されるDataSnapshotには、新しい子のコンテンツが含まれます。順序付けの目的で、コールバックには 2 番目の引数も渡されます。これは、ソート順による前の兄弟の子のキーを含む文字列、または最初の子の場合はnullです。
onChildMoved(クエリ、コールバック、cancelCallback)特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る主な方法です。コールバックは初期データに対してトリガーされ、データが変更されるたびに再度トリガーされます。返された購読解除コールバックを呼び出して、更新の受信を停止します。詳細については、「Web 上のデータの取得」を参照してください。 onChildMovedイベントは、兄弟に対する相対的な位置が変わるなど、子の並べ替え順序が変更されるとトリガーされます。コールバックに渡されるDataSnapshot移動された子のデータ用です。また、ソート順による前の兄弟の子のキーを含む文字列である 2 番目の引数も渡されます。最初の子の場合はnull
onChildMoved(クエリ、コールバック、オプション)特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る主な方法です。コールバックは初期データに対してトリガーされ、データが変更されるたびに再度トリガーされます。返された購読解除コールバックを呼び出して、更新の受信を停止します。詳細については、「Web 上のデータの取得」を参照してください。 onChildMovedイベントは、兄弟に対する相対的な位置が変わるなど、子の並べ替え順序が変更されるとトリガーされます。コールバックに渡されるDataSnapshot移動された子のデータ用です。また、ソート順による前の兄弟の子のキーを含む文字列である 2 番目の引数も渡されます。最初の子の場合はnull
onChildMoved(クエリ、コールバック、cancelCallback、オプション)特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る主な方法です。コールバックは初期データに対してトリガーされ、データが変更されるたびに再度トリガーされます。返された購読解除コールバックを呼び出して、更新の受信を停止します。詳細については、「Web 上のデータの取得」を参照してください。 onChildMovedイベントは、兄弟に対する相対的な位置が変わるなど、子の並べ替え順序が変更されるとトリガーされます。コールバックに渡されるDataSnapshot移動された子のデータ用です。また、ソート順による前の兄弟の子のキーを含む文字列である 2 番目の引数も渡されます。最初の子の場合はnull
onChildRemoved(クエリ、コールバック、cancelCallback)特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る主な方法です。コールバックは初期データに対してトリガーされ、データが変更されるたびに再度トリガーされます。返された購読解除コールバックを呼び出して、更新の受信を停止します。詳細については、「Web 上のデータの取得」を参照してください。 onChildRemovedイベントは、子が削除されるたびに 1 回トリガーされます。コールバックに渡されるDataSnapshot削除された子の古いデータになります。次のいずれかの場合、子は削除されます。 - クライアントが、その子またはその祖先の 1 つに対して、 remove()明示的に呼び出します。 - クライアントが、その子またはその祖先の 1 つに対してset(null)を呼び出します。 - その子はそのすべての子を削除します。 - 有効なクエリが存在します。子をフィルタリングします (並べ替え順序が変更されたか、最大制限に達したため)
onChildRemoved(クエリ、コールバック、オプション)特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る主な方法です。コールバックは初期データに対してトリガーされ、データが変更されるたびに再度トリガーされます。返された購読解除コールバックを呼び出して、更新の受信を停止します。詳細については、「Web 上のデータの取得」を参照してください。 onChildRemovedイベントは、子が削除されるたびに 1 回トリガーされます。コールバックに渡されるDataSnapshot削除された子の古いデータになります。次のいずれかの場合、子は削除されます。 - クライアントが、その子またはその祖先の 1 つに対して、 remove()明示的に呼び出します。 - クライアントが、その子またはその祖先の 1 つに対してset(null)を呼び出します。 - その子はそのすべての子を削除します。 - 有効なクエリが存在します。子をフィルタリングします (並べ替え順序が変更されたか、最大制限に達したため)
onChildRemoved(クエリ、コールバック、cancelCallback、オプション)特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る主な方法です。コールバックは初期データに対してトリガーされ、データが変更されるたびに再度トリガーされます。返された購読解除コールバックを呼び出して、更新の受信を停止します。詳細については、「Web 上のデータの取得」を参照してください。 onChildRemovedイベントは、子が削除されるたびに 1 回トリガーされます。コールバックに渡されるDataSnapshot削除された子の古いデータになります。次のいずれかの場合、子は削除されます。 - クライアントが、その子またはその祖先の 1 つに対して、 remove()明示的に呼び出します。 - クライアントが、その子またはその祖先の 1 つに対してset(null)を呼び出します。 - その子はそのすべての子を削除します。 - 有効なクエリが存在します。子をフィルタリングします (並べ替え順序が変更されたか、最大制限に達したため)
onValue(クエリ、コールバック、cancelCallback)特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る主な方法です。コールバックは初期データに対してトリガーされ、データが変更されるたびに再度トリガーされます。返された購読解除コールバックを呼び出して、更新の受信を停止します。詳細については、「Web 上のデータの取得」を参照してください。 onValueイベントは、この場所に保存された初期データで 1 回トリガーされ、その後、データが変更されるたびに再度トリガーされます。コールバックに渡されるDataSnapshot on()が呼び出された場所のものになります。コンテンツ全体が同期されるまでトリガーされません。場所にデータがない場合は、空のDataSnapshotでトリガーされます ( val()nullを返します)。
onValue(クエリ、コールバック、オプション)特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る主な方法です。コールバックは初期データに対してトリガーされ、データが変更されるたびに再度トリガーされます。返された購読解除コールバックを呼び出して、更新の受信を停止します。詳細については、「Web 上のデータの取得」を参照してください。 onValueイベントは、この場所に保存された初期データで 1 回トリガーされ、その後、データが変更されるたびに再度トリガーされます。コールバックに渡されるDataSnapshot on()が呼び出された場所のものになります。コンテンツ全体が同期されるまでトリガーされません。場所にデータがない場合は、空のDataSnapshotでトリガーされます ( val()nullを返します)。
onValue(クエリ、コールバック、cancelCallback、オプション)特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る主な方法です。コールバックは初期データに対してトリガーされ、データが変更されるたびに再度トリガーされます。返された購読解除コールバックを呼び出して、更新の受信を停止します。詳細については、「Web 上のデータの取得」を参照してください。 onValueイベントは、この場所に保存された初期データで 1 回トリガーされ、その後、データが変更されるたびに再度トリガーされます。コールバックに渡されるDataSnapshot on()が呼び出された場所のものになります。コンテンツ全体が同期されるまでトリガーされません。場所にデータがない場合は、空のDataSnapshotでトリガーされます ( val()nullを返します)。
クエリ(クエリ、クエリ制約)追加のクエリ制約も含めるように拡張されたQueryの新しい不変インスタンスを作成します。
関数(ref, ...)
onDisconnect(参照) OnDisconnectオブジェクトを返します。使用方法の詳細については、「JavaScript でのオフライン機能の有効化」を参照してください。
削除(参照)このデータベースの場所にあるデータを削除します。子ロケーションにあるデータもすべて削除されます。削除の効果はすぐに表示され、対応するイベント「値」がトリガーされます。 Firebase サーバーへの削除の同期も開始され、完了すると返された Promise が解決されます。指定した場合、onComplete コールバックは、同期の完了後に非同期的に呼び出されます。
runTransaction(ref、transactionUpdate、オプション)この場所のデータをアトミックに変更します。この場所のデータをアトミックに変更します。以前の値に関係なくデータを上書きするだけの通常のset()とは異なり、 runTransaction()既存の値を新しい値に変更するために使用され、同時に同じ場所に書き込む他のクライアントと競合しないようにします。 。これを実現するには、現在の値を新しい値に変換するために使用される更新関数をrunTransaction()に渡します。新しい値が正常に書き込まれる前に別のクライアントがその場所に書き込むと、新しい現在値を使用して更新関数が再度呼び出され、書き込みが再試行されます。これは、書き込みが競合せずに成功するか、更新関数から値を返さなくてトランザクションを中止するまで、繰り返し発生します。注: set()を使用してデータを変更すると、その場所で保留中のトランザクションがすべてキャンセルされるため、 set()runTransaction()を混合して同じデータを更新する場合は細心の注意を払う必要があります。注: セキュリティ ルールと Firebase ルールを適用してトランザクションを使用する場合、クライアントがトランザクションを実行するには、 .readアクセスに加えて.writeアクセスも必要であることに注意してください。これは、トランザクションのクライアント側の性質により、トランザクション的に更新するためにクライアントがデータを読み取る必要があるためです。
set(参照、値)このデータベースの場所にデータを書き込みます。これにより、この場所とすべての子の場所にあるデータが上書きされます。書き込みの効果はすぐに表示され、対応するイベント (「value」、「child_added」など) がトリガーされます。 Firebase サーバーへのデータの同期も開始され、完了すると返された Promise が解決されます。指定した場合、 onCompleteコールバックは、同期の完了後に非同期的に呼び出されます。新しい値としてnullを渡すことは、 remove()を呼び出すことと同じです。つまり、この場所とすべての子の場所にあるすべてのデータが削除されます。 set()はこの場所に保存されている優先度を削除するため、優先度を保持する必要がある場合は、代わりにsetWithPriority()を使用する必要があります。 set()を使用してデータを変更すると、その場所で保留中のトランザクションがすべてキャンセルされるため、 set()transaction()を混合して同じデータを変更する場合は細心の注意を払う必要があることに注意してください。単一のset() set()実行された場所に単一の「値」イベントを生成します。
setPriority(ref, 優先度)このデータベースの場所にあるデータの優先順位を設定します。アプリケーションは優先順位を使用する必要はありませんが、通常のプロパティによってコレクションを順序付けることができます (データの並べ替えとフィルター処理を参照)。
setWithPriority(参照、値、優先度)データをデータベースの場所に書き込みます。 set()と似ていますが、そのデータの優先順位も指定します。アプリケーションは優先順位を使用する必要はありませんが、通常のプロパティによってコレクションを順序付けることができます (データの並べ替えとフィルター処理を参照)。
update(参照、値)複数の値をデータベースに一度に書き込みます。 values引数には、一緒にデータベースに書き込まれる複数のプロパティと値のペアが含まれます。各子プロパティは、単純なプロパティ (たとえば、「name」) にすることも、現在の場所から更新するデータまでの相対パス (たとえば、「name/first」) にすることもできます。 set()メソッドとは対照的に、 update()を使用すると、(現在の場所にあるすべての子プロパティを置き換えるのではなく)、現在の場所にある参照プロパティのみを選択的に更新できます。書き込みの効果はすぐに表示され、対応するイベント (「value」、「child_added」など) がトリガーされます。 Firebase サーバーへのデータの同期も開始され、完了すると返された Promise が解決されます。指定した場合、 onCompleteコールバックは、同期の完了後に非同期的に呼び出されます。 1 つのupdate()変更された子の数に関係なく、 update()が実行された場所に 1 つの「value」イベントを生成します。 update()を使用してデータを変更すると、その場所で保留中のトランザクションがすべてキャンセルされるため、同じデータを変更するためにupdate()transaction()を混合する場合は細心の注意を払う必要があることに注意してください。 update()nullを渡すと、この場所のデータが削除されます。マルチロケーションアップデートの導入などを参照してください。
関数(値, ...)
endAt(値, キー)指定された終了点を使用してQueryConstraintを作成します。 startAt()startAfter()endBefore()endAt()およびequalTo()を使用すると、クエリの任意の開始点と終了点を選択できます。終了点は包括的であるため、指定された値と正確に一致する子がクエリに含まれます。オプションの key 引数を使用すると、クエリの範囲をさらに制限できます。これが指定されている場合、指定された値とまったく同じ値を持つ子も、指定されたキー以下のキー名を持つ必要があります。 endAt()の詳細については、 「データのフィルタリング」を参照してください。
endBefore(値, キー)指定された終了点 (排他的) を使用してQueryConstraintを作成します。 startAt()startAfter()endBefore()endAt()およびequalTo()を使用すると、クエリの任意の開始点と終了点を選択できます。終点は排他的です。値のみを指定した場合、指定した値より小さい値を持つ子がクエリに含まれます。キーが指定されている場合、子の値は指定された値以下であり、キー名は指定されたキーよりも小さい必要があります。
等しい(値, キー)指定された値に一致する子を含むQueryConstraintを作成します。 startAt()startAfter()endBefore()endAt()およびequalTo()を使用すると、クエリの任意の開始点と終了点を選択できます。オプションの key 引数を使用すると、クエリの範囲をさらに制限できます。これが指定されている場合、指定された値と正確に一致する子は、キー名として指定されたキーを正確に持つ必要があります。これを使用して、同じ値に一致するものが多数ある結果セットをフィルタリングできます。 equalTo()の詳細については、 「データのフィルタリング」を参照してください。
startAfter(値, キー)指定された開始点 (排他的) でQueryConstraintを作成します。 startAt()startAfter()endBefore()endAt()およびequalTo()を使用すると、クエリの任意の開始点と終了点を選択できます。出発点は排他的です。値のみを指定した場合は、指定した値より大きい値を持つ子がクエリに含まれます。キーが指定されている場合、子には指定された値以上の値と、指定されたキーよりも大きいキー名が必要です。
startAt(値, キー)指定された開始点でQueryConstraintを作成します。 startAt()startAfter()endBefore()endAt()およびequalTo()を使用すると、クエリの任意の開始点と終了点を選択できます。開始点は包括的であるため、指定された値と正確に一致する子がクエリに含まれます。オプションの key 引数を使用すると、クエリの範囲をさらに制限できます。これが指定されている場合、指定された値と正確に一致する子も、指定されたキー以上のキー名を持っている必要があります。 startAt()の詳細については、 「データのフィルタリング」を参照してください。

クラス

クラス説明
データベースFirebase Realtime Database を表すクラス。
データスナップショットDataSnapshotは、データベースの場所からのデータが含まれています。データベースからデータを読み取るたびに、データをDataSnapshotとして受け取ります。 DataSnapshot on()またはonce()でアタッチしたイベント コールバックに渡されます。 val()メソッドを呼び出すことで、スナップショットの内容を JavaScript オブジェクトとして抽出できます。あるいは、 child()を呼び出して子スナップショットを返すことによって、スナップショットにアクセスすることもできます (その後、 val()を呼び出すことができます)。 DataSnapshotは、データベースの場所にある、効率的に生成されたデータの不変のコピーです。これは変更できず、決して変更されません (データを変更するには、常にReferenceset()メソッドを直接呼び出します)。
切断時onDisconnectクラスを使用すると、クライアントがデータベース サーバーから切断されたときにデータを書き込んだりクリアしたりできます。これらの更新は、クライアントが正常に切断されたかどうかに関係なく行われるため、接続が切断されたりクライアントがクラッシュしたりした場合でも、更新を信頼してデータをクリーンアップできます。 onDisconnectクラスは、アプリケーションでのプレゼンスを管理するために最も一般的に使用されます。接続されているクライアントの数や、他のクライアントがいつ切断されたかを検出するのに役立ちます。詳細については、「JavaScript でのオフライン機能の有効化」を参照してください。リクエストがデータベース サーバーに転送される前に接続が切断された場合の問題を回避するには、データを書き込む前にこれらの関数を呼び出す必要があります。 onDisconnect操作は 1 回だけトリガーされることに注意してください。切断が発生するたびに操作を実行する場合は、再接続するたびにonDisconnect操作を再確立する必要があります。
クエリ制約QueryConstraintは、データベース クエリによって返されるドキュメントのセットを絞り込むために使用されます。 QueryConstraintは、 endAt()を呼び出すことによって作成されます。endBefore()startAt()startAfter()limitToFirst()limitToLast()orderByChild()orderByChild()orderByKey()orderByPriority()orderByValue() 、またはqualTo()クエリ()に渡して、このQueryConstraintも含む新しいクエリ インスタンスを作成できます。
トランザクション結果runTransaction()の解決値の型

インターフェース

インターフェース説明
データベースリファレンスDatabaseReferenceはデータベース内の特定の場所を表し、そのデータベースの場所に対するデータの読み取りまたは書き込みに使用できます。 ref()またはref("child/path")を呼び出すことで、データベース内のルートまたは子の場所を参照できます。書き込みはset()メソッドで実行され、読み取りはon*()メソッドで実行できます。 https://firebase.google.com/docs/database/web/read-and-writeを参照してください。
反復データスナップショット反復処理されているReferenceの子スナップショットを表します。キーが未定義になることはありません。
リッスンオプションリスナーをカスタマイズするために使用できるオプション オブジェクト。
クエリQuery 、データベースの場所でデータを並べ替えてフィルタリングし、子データのサブセットのみが含まれるようにします。これを使用すると、データのコレクションを何らかの属性 (恐竜の身長など) で並べ替えたり、項目の大きなリスト (チャット メッセージなど) をクライアントとの同期に適した数に制限したりすることができます。クエリは、ここで定義された 1 つ以上のフィルター メソッドを連鎖させることによって作成されます。 DatabaseReferenceと同様に、 on*()メソッドを使用してQueryからデータを受け取ることができます。クエリに一致するデータのサブセットのイベントとDataSnapshotのみを受け取ります。詳細については、 https://firebase.google.com/docs/database/web/lists-of-data#sorting_and_filtering_dataを参照してください。
thenableReference Push()によって返されたときにDatabaseReferenceとしても機能するPromise 。参照はすぐに利用可能になり、バックエンドへの書き込みが完了するとPromiseが解決されます。
トランザクションオプショントランザクションを設定するためのオプション オブジェクト。

タイプエイリアス

タイプエイリアス説明
イベントタイプ次の文字列のいずれか: 「value」、「child_added」、「child_changed」、「child_removed」、または「child_moved」。
クエリ制約タイプこの SDK で使用できるさまざまなクエリ制約について説明します。
購読を解除するリスナーを削除するために呼び出すことができるコールバック。

関数(アプリ、...)

getDataBase(APP、URL)

提供されたFireBaseAppに関連付けられているリアルタイムデータベースSDKのインスタンスを返します。インスタンスが存在しない場合、または既存のインスタンスがカスタムデータベースURLを使用している場合、デフォルト設定で新しいインスタンスを初期化します。

サイン:

export declare function getDatabase(app?: FirebaseApp, url?: string): Database;

パラメーター

パラメータタイプ説明
アプリFireBaseapp返されたリアルタイムデータベースインスタンスが関連付けられているFireBaseAppインスタンス。
URL接続するリアルタイムデータベースインスタンスのURL。提供されていない場合、SDKはFireBaseアプリのデフォルトインスタンスに接続します。

戻り値:

データベース

提供されたアプリのDatabaseインスタンス。

関数(db、...)

ConnectDataBaseEmulator(DB、ホスト、ポート、オプション)

提供されたインスタンスを変更して、リアルタイムデータベースエミュレーターと通信します。

注:他の操作を実行する前に、この方法を呼び出す必要があります。

サイン:

export declare function connectDatabaseEmulator(db: Database, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

パラメーター

パラメータタイプ説明
データベースデータベース変更するインスタンス。
ホストエミュレータホスト(例:localhost)
ポート番号エミュレータポート(例:8080)
オプション{mockusertoken?: emulatormocktokenoptions |弦; }

戻り値:

空所

GoOffline(DB)

サーバーから切断されます(すべてのデータベース操作はオフラインになります)。

クライアントは、データベースサーバーへの永続的な接続を自動的に維持します。データベースサーバーは無期限にアクティブなままで、切断時に再接続します。ただし、永続的な接続が望ましくない場合にクライアント接続を制御するためにgoOffline()およびgoOnline()メソッドを使用することができます。

オフラインである間、クライアントはデータベースからデータの更新を受け取りません。ただし、ローカルで実行されるすべてのデータベース操作は、すぐにイベントを発射し続け、アプリケーションが正常に動作し続けることができます。さらに、ローカルで実行される各操作は、自動的にキューにキューにされ、データベースサーバーへの再接続時に再試行されます。

データベースに再接続してリモートイベントの受信を開始するには、 goOnline()を参照してください

サイン:

export declare function goOffline(db: Database): void;

パラメーター

パラメータタイプ説明
データベースデータベース切断するインスタンス。

戻り値:

空所

Goonline(DB)

サーバーに再接続し、オフラインデータベース状態をサーバー状態と同期します。

この方法は、 goOffline()とのアクティブな接続を無効にした後に使用する必要があります。再接続すると、クライアントは適切なデータを送信し、適切なイベントを起動して、クライアントが自動的に「追いつく」ようになります。

サイン:

export declare function goOnline(db: Database): void;

パラメーター

パラメータタイプ説明
データベースデータベース再接続するインスタンス。

戻り値:

空所

ref(db、path)

提供されたパスに対応するデータベース内の場所を表すReferenceを返します。パスが提供されていない場合、 Referenceデータベースのルートを指します。

サイン:

export declare function ref(db: Database, path?: string): DatabaseReference;

パラメーター

パラメータタイプ説明
データベースデータベースデータベースインスタンスは参照を取得します。
パス返されたReferenceポイントする場所を表すオプションのパス。提供されていない場合、返されたReferenceデータベースのルートを指します。

戻り値:

データベースレファレンス

パスが提供されている場合、提供されたパスを指すReference 。それ以外の場合、データベースのルートを指すReference

reffromurl(db、url)

提供されたFirebase URLに対応するデータベース内の場所を表すReferenceを返します。

URLが有効なFireBaseデータベースURLではない場合、または現在のDatabaseインスタンスとは異なるドメインがある場合、例外がスローされます。

すべてのクエリパラメーター( orderByに注意してくださいlimitToLastなど)は無視され、返されたReferenceには適用されません

サイン:

export declare function refFromURL(db: Database, url: string): DatabaseReference;

パラメーター

パラメータタイプ説明
データベースデータベースデータベースインスタンスは参照を取得します。
URL返されたReferenceがポイントするファイヤーベースURL。

戻り値:

データベースレファレンス

提供されたFirebase URLを指すReference

関数()

forcelOngpolling()

WebSocketsの代わりにLongpollingの使用を強制します。これは、DataBaseUrlでWebSocketプロトコルが使用される場合に無視されます。

サイン:

export declare function forceLongPolling(): void;

戻り値:

空所

forcewebsockets()

ロングポールの代わりに、WebSocketの使用を強制します。

サイン:

export declare function forceWebSockets(): void;

戻り値:

空所

OrderByKey()

キーが注文する新しいQueryConstraintを作成します。

クエリの結果を(上昇する)キー値で並べ替えます。

並べ替えデータorderByKey()の詳細を読むことができます

サイン:

export declare function orderByKey(): QueryConstraint;

戻り値:

QueryConstraint

OrderByPriority()

優先順位で注文する新しいQueryConstraintを作成します。

アプリケーションは優先度を使用する必要はありませんが、通常のプロパティでコレクションを注文できます(優先度の代替案については、ソートデータを参照してください。

サイン:

export declare function orderByPriority(): QueryConstraint;

戻り値:

QueryConstraint

OrderByValue()

価値ごとに注文する新しいQueryConstraintを作成します。

クエリの子供がすべてスカラー値(文字列、数字、またはブール波)である場合、結果を(昇る)値で注文できます。

sortデータorderByValue()の詳細を読むことができます

サイン:

export declare function orderByValue(): QueryConstraint;

戻り値:

QueryConstraint

servertimestamp()

Firebaseサーバーによって決定されているように、現在のタイムスタンプ(Unix Epoch以来のMillisecondsでの時間)を自動入力するためのプレースホルダー価値を返します。

サイン:

export declare function serverTimestamp(): object;

戻り値:

物体

関数(デルタ、...)

増分(デルタ)

提供されたデルタによって現在のデータベース値を原子的に増分するために使用できるプレースホルダー値を返します。

サイン:

export declare function increment(delta: number): object;

パラメーター

パラメータタイプ説明
デルタ番号現在の値を原子的に変更する量。

戻り値:

物体

原子的サーバー側を変更するためのプレースホルダー値。

関数(有効、...)

イネーブログ(有効、永続的)

ログは情報をコンソールにデバッグします。

サイン:

export declare function enableLogging(enabled: boolean, persistent?: boolean): any;

パラメーター

パラメータタイプ説明
有効になっていますブールtrueの場合はログを有効にし、 false場合はログを無効にします。
持続的ブールtrueの場合は、ページ間のロギング状態を覚えています。

戻り値:

どれでも

関数(制限、...)

limittofirst(制限)

最初の特定の数の子供に制限されている場合、新しいQueryConstraintを作成します。

limitToFirst()メソッドは、特定のコールバックに対して同期する最大数の子供を設定するために使用されます。 100の制限を設定した場合、最初は最大100個のchild_addedイベントのみを受け取ります。データベースに100未満のメッセージが保存されている場合、各メッセージに対してchild_addedイベントが発生します。ただし、100を超えるメッセージがある場合は、最初の100件の注文メッセージに対してchild_addedイベントのみを受け取ります。アイテムが変更されると、総数が100にとどまるように、アクティブリストから抜け出す各アイテムのchild_removedイベントを受け取ります。

データのフィルタリングlimitToFirst()の詳細を読むことができます

サイン:

export declare function limitToFirst(limit: number): QueryConstraint;

パラメーター

パラメータタイプ説明
限界番号このクエリに含めるノードの最大数。

戻り値:

QueryConstraint

Limittolast(制限)

最終指定された数の子供のみを返すことに限定された新しいQueryConstraintを作成します。

limitToLast()メソッドは、特定のコールバックに対して同期する最大数の子供を設定するために使用されます。 100の制限を設定した場合、最初は最大100個のchild_addedイベントのみを受け取ります。データベースに100未満のメッセージが保存されている場合、各メッセージに対してchild_addedイベントが発生します。ただし、100を超えるメッセージがある場合は、最後の100の注文メッセージに対してchild_addedイベントのみを受け取ります。アイテムが変更されると、総数が100にとどまるように、アクティブリストから抜け出す各アイテムのchild_removedイベントを受け取ります。

データのフィルタリングlimitToLast()の詳細を読むことができます

サイン:

export declare function limitToLast(limit: number): QueryConstraint;

パラメーター

パラメータタイプ説明
限界番号このクエリに含めるノードの最大数。

戻り値:

QueryConstraint

関数(ロガー、...)

enablelogging(ロガー)

ログは情報をコンソールにデバッグします。

サイン:

export declare function enableLogging(logger: (message: string) => unknown): any;

パラメーター

パラメータタイプ説明
ロガー(メッセージ:文字列)=>不明物事がログインする方法を制御するカスタムロガー関数。

戻り値:

どれでも

関数(親、...)

子供(親、道)

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

相対パスは、単純な子名(たとえば、「ADA」)またはより深いスラッシュ分離されたパス(たとえば、「ADA/NAME/FIRST」)のいずれかです。

サイン:

export declare function child(parent: DatabaseReference, path: string): DatabaseReference;

パラメーター

パラメータタイプ説明
データベースレファレンス親の場所。
パスこの場所から目的の子供の場所への相対的な経路。

戻り値:

データベースレファレンス

指定された子供の場所。

プッシュ(親、値)

一意のキーを使用して新しい子供の場所を生成し、そのReferenceを返します

これは、アイテムのコレクションにデータを追加するための最も一般的なパターンです。

push()に値を提供する場合、値は生成された場所に書き込まれます。値を渡さない場合、データベースには何も書かれておらず、子供は空のままです(ただし、他の場所でReference使用できます)。

push()によって生成された一意のキーは、現在の時刻によって順序付けられるため、アイテムの結果のリストは年代順にソートされます。キーは、装備できないように設計されています(72のランダムビットのエントロピーが含まれています)。

データのリストの追加を参照してください一意の識別子を確保するための2^120の方法を参照してください

サイン:

export declare function push(parent: DatabaseReference, value?: unknown): ThenableReference;

パラメーター

パラメータタイプ説明
データベースレファレンス親の場所。
価値未知生成された場所で記述されるオプションの値。

戻り値:

次に、ablereference

PromiseReferenceの組み合わせ;書き込みが完了したときに解決しますが、子供の場所へのReferenceとしてすぐに使用できます。

関数(パス、...)

OrderByChild(パス)

指定された子キーによって注文する新しいQueryConstraintを作成します。

クエリは、一度に1つのキーでのみ注文できます。同じクエリでorderByChild()を複数回呼び出すことはエラーです。

FireBaseクエリを使用すると、その場で任意の子キーでデータを注文できます。ただし、インデックスが何であるかを事前に知っている場合は、セキュリティルールの.indexonルールを使用して、パフォーマンスを向上させることができます。詳細については、 https://firebase.google.com/docs/database/security/indexing-dataルールを参照してください。

sortデータorderByChild()の詳細を読むことができます

サイン:

export declare function orderByChild(path: string): QueryConstraint;

パラメーター

パラメータタイプ説明
パス注文するパス。

戻り値:

QueryConstraint

関数(クエリ、...)

取得(クエリ)

このクエリの最新の結果を取得します。

サイン:

export declare function get(query: Query): Promise<DataSnapshot>;

パラメーター

パラメータタイプ説明
クエリクエリ実行するクエリ。

戻り値:

約束< DataSnapShot >

結果のデータを解決するPromise 、値が利用可能である場合、またはクライアントが値を返すことができない場合に拒否します(たとえば、サーバーが到達できず、キャッシュされていない場合)。

off(query、eventtype、callback)

対応するon*()onValueで以前に添付されているコールバックがデタッチされますonChildAdded )リスナー。注:これは、リスナーを削除する推奨方法ではありません。代わりに、それぞれon*コールバックから返されたコールバック関数を使用してください。

on*()で以前に添付されたコールバックを取り外します。親のリスナーでコールオフoff()は、子ノードに登録されているリスナーを自動的に削除しません。 off() 、コールバックを削除するためにチャイルドリスナーにも呼び出される必要があります。

コールバックが指定されていない場合、指定されたEventTypeのすべてのコールバックが削除されます。同様に、EventTypeが指定されていない場合、 Referenceのすべてのコールバックが削除されます。

個々のリスナーは、登録解除コールバックを呼び出すことで削除することもできます。

サイン:

export declare function off(query: Query, eventType?: EventType, callback?: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown): void;

パラメーター

パラメータタイプ説明
クエリクエリリスナーが登録されたクエリ。
イベントタイプイベントタイプ次の文字列のいずれか:「値」、「child_added」、「child_changed」、「child_removed」、または「child_moved」。省略すると、 Referenceのすべてのコールバックが削除されます。
折り返し電話(スナップショット: DataSnapShot 、前ChildName?:String | null)=>不明すべてのコールバックを削除するためにon()またはundefinedに渡されたコールバック関数。

戻り値:

空所

onChildadded(クエリ、コールバック、cancelcallback)

特定の場所でのデータの変更を聴きます。

これは、データベースからデータを読み取る主要な方法です。コールバックは、初期データに対してトリガーされ、データが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新の受信を停止します。詳細については、Web上のデータの取得を参照してください。

この場所のonChildAddedの子供ごとに一度トリガーされ、新しい子供が追加されるたびに再びトリガーされます。コールバックに渡されたDataSnapshot関連する子のデータを反映します。秩序の目的のために、それはソートオーダーによって前の兄弟の子供の鍵を含む文字列、またはそれが最初の子供である場合はnullある2番目の引数を渡されます。

サイン:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

パラメーター

パラメータタイプ説明
クエリクエリ実行するクエリ。
折り返し電話(スナップショット: DataSnapShot 、前ChildName?:String | null)=>不明指定されたイベントが発生したときに発火するコールバック。コールバックは、ソートオーダー、または最初の子供である場合は、 nullオーダーによって、前の子供の鍵を含むDataSnapshotと文字列に渡されます。
CancelCallback (エラー:エラー)=>不明クライアントがこのデータを読み取る許可を持たないためにイベントサブスクリプションがキャンセルされた場合に通知されるオプションのコールバック(または許可がありましたが、現在失われています)。このコールバックは、障害が発生した理由を示すErrorオブジェクトに渡されます。

戻り値:

購読を解除する

リスナーを削除するために呼び出すことができる関数。

onChildadded(クエリ、コールバック、オプション)

特定の場所でのデータの変更を聴きます。

これは、データベースからデータを読み取る主要な方法です。コールバックは、初期データに対してトリガーされ、データが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新の受信を停止します。詳細については、Web上のデータの取得を参照してください。

この場所のonChildAddedの子供ごとに一度トリガーされ、新しい子供が追加されるたびに再びトリガーされます。コールバックに渡されたDataSnapshot関連する子のデータを反映します。秩序の目的のために、それはソートオーダーによって前の兄弟の子供の鍵を含む文字列、またはそれが最初の子供である場合はnullある2番目の引数を渡されます。

サイン:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

パラメーター

パラメータタイプ説明
クエリクエリ実行するクエリ。
折り返し電話(スナップショット: DataSnapShot 、前ChildName:文字列| null)=>不明指定されたイベントが発生したときに発火するコールバック。コールバックは、ソートオーダー、または最初の子供である場合は、 nullオーダーによって、前の子供の鍵を含むDataSnapshotと文字列に渡されます。
オプションリッスンオプションonlyOnceの構成に使用できるオブジェクトで、最初の呼び出し後にリスナーを削除します。

戻り値:

購読を解除する

リスナーを削除するために呼び出すことができる関数。

onChildadded(クエリ、コールバック、cancelcallback、オプション)

特定の場所でのデータの変更を聴きます。

これは、データベースからデータを読み取る主要な方法です。コールバックは、初期データに対してトリガーされ、データが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新の受信を停止します。詳細については、Web上のデータの取得を参照してください。

この場所のonChildAddedの子供ごとに一度トリガーされ、新しい子供が追加されるたびに再びトリガーされます。コールバックに渡されたDataSnapshot関連する子のデータを反映します。秩序の目的のために、それはソートオーダーによって前の兄弟の子供の鍵を含む文字列、またはそれが最初の子供である場合はnullある2番目の引数を渡されます。

サイン:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

パラメーター

パラメータタイプ説明
クエリクエリ実行するクエリ。
折り返し電話(スナップショット: DataSnapShot 、前ChildName:文字列| null)=>不明指定されたイベントが発生したときに発火するコールバック。コールバックは、ソートオーダー、または最初の子供である場合は、 nullオーダーによって、前の子供の鍵を含むDataSnapshotと文字列に渡されます。
CancelCallback (エラー:エラー)=>不明クライアントがこのデータを読み取る許可を持たないためにイベントサブスクリプションがキャンセルされた場合に通知されるオプションのコールバック(または許可がありましたが、現在失われています)。このコールバックは、障害が発生した理由を示すErrorオブジェクトに渡されます。
オプションリッスンオプションonlyOnceの構成に使用できるオブジェクトで、最初の呼び出し後にリスナーを削除します。

戻り値:

購読を解除する

リスナーを削除するために呼び出すことができる関数。

onchildChanged(クエリ、コールバック、cancelCallback)

特定の場所でのデータの変更を聴きます。

これは、データベースからデータを読み取る主要な方法です。コールバックは、初期データに対してトリガーされ、データが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新の受信を停止します。詳細については、Web上のデータの取得を参照してください。

子(またはその子孫のいずれか)に保存されているデータが変更されたときに、 onChildChangedイベントがトリガーされます。単一のchild_changedイベントは、子供の複数の変更を表す場合があることに注意してください。コールバックに渡されたDataSnapshotには、新しい子の内容が含まれます。注文のために、コールバックは、ソートオーダーによって前の兄弟の子供の鍵を含む文字列、またはそれが最初の子供である場合はnullある2番目の引数も渡されます。

サイン:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

パラメーター

パラメータタイプ説明
クエリクエリ実行するクエリ。
折り返し電話(スナップショット: DataSnapShot 、前ChildName:文字列| null)=>不明指定されたイベントが発生したときに発火するコールバック。コールバックは、ソートオーダー、または最初の子供である場合は、 nullオーダーによって、前の子供の鍵を含むDataSnapshotと文字列に渡されます。
CancelCallback (エラー:エラー)=>不明クライアントがこのデータを読み取る許可を持たないためにイベントサブスクリプションがキャンセルされた場合に通知されるオプションのコールバック(または許可がありましたが、現在失われています)。このコールバックは、障害が発生した理由を示すErrorオブジェクトに渡されます。

戻り値:

購読を解除する

リスナーを削除するために呼び出すことができる関数。

onchildChanged(クエリ、コールバック、オプション)

特定の場所でのデータの変更を聴きます。

これは、データベースからデータを読み取る主要な方法です。コールバックは、初期データに対してトリガーされ、データが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新の受信を停止します。詳細については、Web上のデータの取得を参照してください。

子(またはその子孫のいずれか)に保存されているデータが変更されたときに、 onChildChangedイベントがトリガーされます。単一のchild_changedイベントは、子供の複数の変更を表す場合があることに注意してください。コールバックに渡されたDataSnapshotには、新しい子の内容が含まれます。注文のために、コールバックは、ソートオーダーによって前の兄弟の子供の鍵を含む文字列、またはそれが最初の子供である場合はnullある2番目の引数も渡されます。

サイン:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

パラメーター

パラメータタイプ説明
クエリクエリ実行するクエリ。
折り返し電話(スナップショット: DataSnapShot 、前ChildName:文字列| null)=>不明指定されたイベントが発生したときに発火するコールバック。コールバックは、ソートオーダー、または最初の子供である場合は、 nullオーダーによって、前の子供の鍵を含むDataSnapshotと文字列に渡されます。
オプションリッスンオプションonlyOnceの構成に使用できるオブジェクトで、最初の呼び出し後にリスナーを削除します。

戻り値:

購読を解除する

リスナーを削除するために呼び出すことができる関数。

onChildChanged(クエリ、コールバック、cancelCallback、オプション)

特定の場所でのデータの変更を聴きます。

これは、データベースからデータを読み取る主要な方法です。コールバックは、初期データに対してトリガーされ、データが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新の受信を停止します。詳細については、Web上のデータの取得を参照してください。

子(またはその子孫のいずれか)に保存されているデータが変更されたときに、 onChildChangedイベントがトリガーされます。単一のchild_changedイベントは、子供の複数の変更を表す場合があることに注意してください。コールバックに渡されたDataSnapshotには、新しい子の内容が含まれます。注文のために、コールバックは、ソートオーダーによって前の兄弟の子供の鍵を含む文字列、またはそれが最初の子供である場合はnullある2番目の引数も渡されます。

サイン:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

パラメーター

パラメータタイプ説明
クエリクエリ実行するクエリ。
折り返し電話(スナップショット: DataSnapShot 、前ChildName:文字列| null)=>不明指定されたイベントが発生したときに発火するコールバック。コールバックは、ソートオーダー、または最初の子供である場合は、 nullオーダーによって、前の子供の鍵を含むDataSnapshotと文字列に渡されます。
CancelCallback (エラー:エラー)=>不明クライアントがこのデータを読み取る許可を持たないためにイベントサブスクリプションがキャンセルされた場合に通知されるオプションのコールバック(または許可がありましたが、現在失われています)。このコールバックは、障害が発生した理由を示すErrorオブジェクトに渡されます。
オプションリッスンオプションonlyOnceの構成に使用できるオブジェクトで、最初の呼び出し後にリスナーを削除します。

戻り値:

購読を解除する

リスナーを削除するために呼び出すことができる関数。

onchildmoved(query、callback、cancelcallback)

特定の場所でのデータの変更を聴きます。

これは、データベースからデータを読み取る主要な方法です。コールバックは、初期データに対してトリガーされ、データが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新の受信を停止します。詳細については、Web上のデータの取得を参照してください。

子供の並べ替えの順序が変更され、その兄弟との位置が変化するようになったときに、 onChildMovedイベントがトリガーされます。コールバックに渡されたDataSnapshot動いた子供のデータのためです。また、ソートオーダーによって前の兄弟の子供の鍵を含む文字列、またはそれが最初の子供である場合はnullある2番目の引数も渡されます。

サイン:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

パラメーター

パラメータタイプ説明
クエリクエリ実行するクエリ。
折り返し電話(スナップショット: DataSnapShot 、前ChildName:文字列| null)=>不明指定されたイベントが発生したときに発火するコールバック。コールバックは、ソートオーダー、または最初の子供である場合は、 nullオーダーによって、前の子供の鍵を含むDataSnapshotと文字列に渡されます。
CancelCallback (エラー:エラー)=>不明クライアントがこのデータを読み取る許可を持たないためにイベントサブスクリプションがキャンセルされた場合に通知されるオプションのコールバック(または許可がありましたが、現在失われています)。このコールバックは、障害が発生した理由を示すErrorオブジェクトに渡されます。

戻り値:

購読を解除する

リスナーを削除するために呼び出すことができる関数。

onchildmoved(query、callback、options)

特定の場所でのデータの変更を聴きます。

これは、データベースからデータを読み取る主要な方法です。コールバックは、初期データに対してトリガーされ、データが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新の受信を停止します。詳細については、Web上のデータの取得を参照してください。

子供の並べ替えの順序が変更され、その兄弟との位置が変化するようになったときに、 onChildMovedイベントがトリガーされます。コールバックに渡されたDataSnapshot動いた子供のデータのためです。また、ソートオーダーによって前の兄弟の子供の鍵を含む文字列、またはそれが最初の子供である場合はnullある2番目の引数も渡されます。

サイン:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

パラメーター

パラメータタイプ説明
クエリクエリ実行するクエリ。
折り返し電話(スナップショット: DataSnapShot 、前ChildName:文字列| null)=>不明指定されたイベントが発生したときに発火するコールバック。コールバックは、ソートオーダー、または最初の子供である場合は、 nullオーダーによって、前の子供の鍵を含むDataSnapshotと文字列に渡されます。
オプションリッスンオプションonlyOnceの構成に使用できるオブジェクトで、最初の呼び出し後にリスナーを削除します。

戻り値:

購読を解除する

リスナーを削除するために呼び出すことができる関数。

onchildmoved(query、callback、cancelcallback、options)

特定の場所でのデータの変更を聴きます。

これは、データベースからデータを読み取る主要な方法です。コールバックは、初期データに対してトリガーされ、データが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新の受信を停止します。詳細については、Web上のデータの取得を参照してください。

子供の並べ替えの順序が変更され、その兄弟との位置が変化するようになったときに、 onChildMovedイベントがトリガーされます。コールバックに渡されたDataSnapshot動いた子供のデータのためです。また、ソートオーダーによって前の兄弟の子供の鍵を含む文字列、またはそれが最初の子供である場合はnullある2番目の引数も渡されます。

サイン:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

パラメーター

パラメータタイプ説明
クエリクエリ実行するクエリ。
折り返し電話(スナップショット: DataSnapShot 、前ChildName:文字列| null)=>不明指定されたイベントが発生したときに発火するコールバック。コールバックは、ソートオーダー、または最初の子供である場合は、 nullオーダーによって、前の子供の鍵を含むDataSnapshotと文字列に渡されます。
CancelCallback (エラー:エラー)=>不明クライアントがこのデータを読み取る許可を持たないためにイベントサブスクリプションがキャンセルされた場合に通知されるオプションのコールバック(または許可がありましたが、現在失われています)。このコールバックは、障害が発生した理由を示すErrorオブジェクトに渡されます。
オプションリッスンオプションonlyOnceの構成に使用できるオブジェクトで、最初の呼び出し後にリスナーを削除します。

戻り値:

購読を解除する

リスナーを削除するために呼び出すことができる関数。

onchildremoved(query、callback、cancelcallback)

特定の場所でのデータの変更を聴きます。

これは、データベースからデータを読み取る主要な方法です。コールバックは、初期データに対してトリガーされ、データが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新の受信を停止します。詳細については、Web上のデータの取得を参照してください。

子供がonChildRemovedされるたびに一度トリガーされます。コールバックに渡されたDataSnapshot削除された子供の古いデータになります。どちらかの場合、子供は削除されます。

  • クライアントは、その子供またはその祖先の1人にremove()明示的に呼び出します - クライアントはその子供またはその先祖の1人にset(null)を呼び出します - 子供はそのすべての子供を削除しています -子供の外(ソート順序が変更されたか、最大制限がヒットしたため)

サイン:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

パラメーター

パラメータタイプ説明
クエリクエリ実行するクエリ。
折り返し電話(スナップショット: DataSnapShot )=>不明指定されたイベントが発生したときに発火するコールバック。コールバックは、ソートオーダー、または最初の子供である場合は、 nullオーダーによって、前の子供の鍵を含むDataSnapshotと文字列に渡されます。
CancelCallback (エラー:エラー)=>不明クライアントがこのデータを読み取る許可を持たないためにイベントサブスクリプションがキャンセルされた場合に通知されるオプションのコールバック(または許可がありましたが、現在失われています)。このコールバックは、障害が発生した理由を示すErrorオブジェクトに渡されます。

戻り値:

購読を解除する

リスナーを削除するために呼び出すことができる関数。

onchildremoved(クエリ、コールバック、オプション)

特定の場所でのデータの変更を聴きます。

これは、データベースからデータを読み取る主要な方法です。コールバックは、初期データに対してトリガーされ、データが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新の受信を停止します。詳細については、Web上のデータの取得を参照してください。

子供がonChildRemovedされるたびに一度トリガーされます。コールバックに渡されたDataSnapshot削除された子供の古いデータになります。どちらかの場合、子供は削除されます。

  • クライアントは、その子供またはその祖先の1人にremove()明示的に呼び出します - クライアントはその子供またはその先祖の1人にset(null)を呼び出します - 子供はそのすべての子供を削除しています -子供の外(ソート順序が変更されたか、最大制限がヒットしたため)

サイン:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;

パラメーター

パラメータタイプ説明
クエリクエリ実行するクエリ。
折り返し電話(スナップショット: DataSnapShot )=>不明指定されたイベントが発生したときに発火するコールバック。コールバックは、ソートオーダー、または最初の子供である場合は、 nullオーダーによって、前の子供の鍵を含むDataSnapshotと文字列に渡されます。
オプションリッスンオプションonlyOnceの構成に使用できるオブジェクトで、最初の呼び出し後にリスナーを削除します。

戻り値:

購読を解除する

リスナーを削除するために呼び出すことができる関数。

onchildremoved(query、callback、cancelcallback、options)

特定の場所でのデータの変更を聴きます。

これは、データベースからデータを読み取る主要な方法です。コールバックは、初期データに対してトリガーされ、データが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新の受信を停止します。詳細については、Web上のデータの取得を参照してください。

子供がonChildRemovedされるたびに一度トリガーされます。コールバックに渡されたDataSnapshot削除された子供の古いデータになります。どちらかの場合、子供は削除されます。

  • クライアントは、その子供またはその祖先の1人にremove()明示的に呼び出します - クライアントはその子供またはその先祖の1人にset(null)を呼び出します - 子供はそのすべての子供を削除しています -子供の外(ソート順序が変更されたか、最大制限がヒットしたため)

サイン:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

パラメーター

パラメータタイプ説明
クエリクエリ実行するクエリ。
折り返し電話(スナップショット: DataSnapShot )=>不明指定されたイベントが発生したときに発火するコールバック。コールバックは、ソートオーダー、または最初の子供である場合は、 nullオーダーによって、前の子供の鍵を含むDataSnapshotと文字列に渡されます。
CancelCallback (エラー:エラー)=>不明クライアントがこのデータを読み取る許可を持たないためにイベントサブスクリプションがキャンセルされた場合に通知されるオプションのコールバック(または許可がありましたが、現在失われています)。このコールバックは、障害が発生した理由を示すErrorオブジェクトに渡されます。
オプションリッスンオプションonlyOnceの構成に使用できるオブジェクトで、最初の呼び出し後にリスナーを削除します。

戻り値:

購読を解除する

リスナーを削除するために呼び出すことができる関数。

onvalue(query、callback、cancelcallback)

特定の場所でのデータの変更を聴きます。

これは、データベースからデータを読み取る主要な方法です。コールバックは、初期データに対してトリガーされ、データが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新の受信を停止します。詳細については、Web上のデータの取得を参照してください。

onValueイベントは、この場所に最初のデータが保存されていたときに1回トリガーされ、データが変更されるたびに再度トリガーされます。コールバックに渡されたDataSnapshot on()が呼び出された場所の場合になります。内容全体が同期されるまでトリガーしません。場所にデータがない場合、空のDataSnapshotval()nullを返すことでトリガーされます)。

サイン:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

パラメーター

パラメータタイプ説明
クエリクエリ実行するクエリ。
折り返し電話(スナップショット: DataSnapShot )=>不明指定されたイベントが発生したときに発火するコールバック。コールバックはDataSnapShotに渡されます。
CancelCallback (エラー:エラー)=>不明クライアントがこのデータを読み取る許可を持たないためにイベントサブスクリプションがキャンセルされた場合に通知されるオプションのコールバック(または許可がありましたが、現在失われています)。このコールバックは、障害が発生した理由を示すErrorオブジェクトに渡されます。

戻り値:

購読を解除する

リスナーを削除するために呼び出すことができる関数。

onValue(クエリ、コールバック、オプション)

特定の場所でのデータの変更を聴きます。

これは、データベースからデータを読み取る主要な方法です。コールバックは、初期データに対してトリガーされ、データが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新の受信を停止します。詳細については、Web上のデータの取得を参照してください。

onValueイベントは、この場所に最初のデータが保存されていたときに1回トリガーされ、データが変更されるたびに再度トリガーされます。コールバックに渡されたDataSnapshot on()が呼び出された場所の場合になります。内容全体が同期されるまでトリガーしません。場所にデータがない場合、空のDataSnapshotval()nullを返すことでトリガーされます)。

サイン:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;

パラメーター

パラメータタイプ説明
クエリクエリ実行するクエリ。
折り返し電話(スナップショット: DataSnapShot )=>不明指定されたイベントが発生したときに発火するコールバック。コールバックはDataSnapShotに渡されます。
オプションリッスンオプションonlyOnceの構成に使用できるオブジェクトで、最初の呼び出し後にリスナーを削除します。

戻り値:

購読を解除する

リスナーを削除するために呼び出すことができる関数。

onvalue(query、callback、cancelcallback、options)

特定の場所でのデータの変更を聴きます。

これは、データベースからデータを読み取る主要な方法です。コールバックは、初期データに対してトリガーされ、データが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新の受信を停止します。詳細については、Web上のデータの取得を参照してください。

onValueイベントは、この場所に最初のデータが保存されていたときに1回トリガーされ、データが変更されるたびに再度トリガーされます。コールバックに渡されたDataSnapshot on()が呼び出された場所の場合になります。内容全体が同期されるまでトリガーしません。場所にデータがない場合、空のDataSnapshotval()nullを返すことでトリガーされます)。

サイン:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

パラメーター

パラメータタイプ説明
クエリクエリ実行するクエリ。
折り返し電話(スナップショット: DataSnapShot )=>不明指定されたイベントが発生したときに発火するコールバック。コールバックはDataSnapShotに渡されます。
CancelCallback (エラー:エラー)=>不明クライアントがこのデータを読み取る許可を持たないためにイベントサブスクリプションがキャンセルされた場合に通知されるオプションのコールバック(または許可がありましたが、現在失われています)。このコールバックは、障害が発生した理由を示すErrorオブジェクトに渡されます。
オプションリッスンオプションonlyOnceの構成に使用できるオブジェクトで、最初の呼び出し後にリスナーを削除します。

戻り値:

購読を解除する

リスナーを削除するために呼び出すことができる関数。

クエリ(クエリ、QueryConstraints)

追加のクエリ制約を含むように拡張されたQueryの新しい不変のインスタンスを作成します。

サイン:

export declare function query(query: Query, ...queryConstraints: QueryConstraint[]): Query;

パラメーター

パラメータタイプ説明
クエリクエリ新しい制約のベースとして使用するクエリインスタンス。
QueryConstraints QueryConstraint []適用するQueryConstraint sのリスト。

戻り値:

クエリ

例外

if any of the provided query constraints cannot be combined with the existing or new constraints.

function(ref, ...)

onDisconnect(ref)

Returns an OnDisconnect object - see Enabling Offline Capabilities in JavaScript for more information on how to use it.

サイン:

export declare function onDisconnect(ref: DatabaseReference): OnDisconnect;

パラメーター

パラメータタイプ説明
参照DatabaseReference The reference to add OnDisconnect triggers for.

戻り値:

OnDisconnect

remove(ref)

Removes the data at this Database location.

Any data at child locations will also be deleted.

The effect of the remove will be visible immediately and the corresponding event 'value' will be triggered. Synchronization of the remove to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

サイン:

export declare function remove(ref: DatabaseReference): Promise<void>;

パラメーター

パラメータタイプ説明
参照DatabaseReference The location to remove.

戻り値:

Promise<void>

Resolves when remove on server is complete.

runTransaction(ref, transactionUpdate, options)

Atomically modifies the data at this location.

Atomically modify the data at this location. Unlike a normal set() , which just overwrites the data regardless of its previous value, runTransaction() is used to modify the existing value to a new value, ensuring there are no conflicts with other clients writing to the same location at the same time.

To accomplish this, you pass runTransaction() an update function which is used to transform the current value into a new value. If another client writes to the location before your new value is successfully written, your update function will be called again with the new current value, and the write will be retried. This will happen repeatedly until your write succeeds without conflict or you abort the transaction by not returning a value from your update function.

サイン:

export declare function runTransaction(ref: DatabaseReference, transactionUpdate: (currentData: any) => unknown, options?: TransactionOptions): Promise<TransactionResult>;

パラメーター

パラメータタイプ説明
参照DatabaseReference The location to atomically modify.
transactionUpdate (currentData: any) => unknown A developer-supplied function which will be passed the current data stored at this location (as a JavaScript object). The function should return the new value it would like written (as a JavaScript object). If undefined is returned (ie you return with no arguments) the transaction will be aborted and the data at this location will not be modified.
オプションTransactionOptions An options object to configure transactions.

戻り値:

Promise< TransactionResult >

A Promise that can optionally be used instead of the onComplete callback to handle success and failure.

set(ref, value)

Writes data to this Database location.

This will overwrite any data at this location and all child locations.

The effect of the write will be visible immediately, and the corresponding events ("value", "child_added", etc.) will be triggered. Synchronization of the data to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

Passing null for the new value is equivalent to calling remove() ; namely, all data at this location and all child locations will be deleted.

set() will remove any priority stored at this location, so if priority is meant to be preserved, you need to use setWithPriority() instead.

Note that modifying data with set() will cancel any pending transactions at that location, so extreme care should be taken if mixing set() and transaction() to modify the same data.

A single set() will generate a single "value" event at the location where the set() was performed.

サイン:

export declare function set(ref: DatabaseReference, value: unknown): Promise<void>;

パラメーター

パラメータタイプ説明
参照DatabaseReference The location to write to.
価値未知The value to be written (string, number, boolean, object, array, or null).

戻り値:

Promise<void>

Resolves when write to server is complete.

setPriority(ref, priority)

Sets a priority for the data at this Database location.

Applications need not use priority but can order collections by ordinary properties (see Sorting and filtering data ).

サイン:

export declare function setPriority(ref: DatabaseReference, priority: string | number | null): Promise<void>;

パラメーター

パラメータタイプ説明
参照DatabaseReference The location to write to.
優先度string | number |ヌルThe priority to be written (string, number, or null).

戻り値:

Promise<void>

Resolves when write to server is complete.

setWithPriority(ref, value, priority)

Writes data the Database location. Like set() but also specifies the priority for that data.

Applications need not use priority but can order collections by ordinary properties (see Sorting and filtering data ).

サイン:

export declare function setWithPriority(ref: DatabaseReference, value: unknown, priority: string | number | null): Promise<void>;

パラメーター

パラメータタイプ説明
参照DatabaseReference The location to write to.
価値未知The value to be written (string, number, boolean, object, array, or null).
優先度string | number |ヌルThe priority to be written (string, number, or null).

戻り値:

Promise<void>

Resolves when write to server is complete.

update(ref, values)

Writes multiple values to the Database at once.

The values argument contains multiple property-value pairs that will be written to the Database together. Each child property can either be a simple property (for example, "name") or a relative path (for example, "name/first") from the current location to the data to update.

As opposed to the set() method, update() can be use to selectively update only the referenced properties at the current location (instead of replacing all the child properties at the current location).

The effect of the write will be visible immediately, and the corresponding events ('value', 'child_added', etc.) will be triggered. Synchronization of the data to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

A single update() will generate a single "value" event at the location where the update() was performed, regardless of how many children were modified.

Note that modifying data with update() will cancel any pending transactions at that location, so extreme care should be taken if mixing update() and transaction() to modify the same data.

Passing null to update() will remove the data at this location.

See Introducing multi-location updates and more

サイン:

export declare function update(ref: DatabaseReference, values: object): Promise<void>;

パラメーター

パラメータタイプ説明
参照DatabaseReference The location to write to.
価値観物体Object containing multiple values.

戻り値:

Promise<void>

Resolves when update on server is complete.

function(value, ...)

endAt(value, key)

Creates a QueryConstraint with the specified ending point.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The ending point is inclusive, so children with exactly the specified value will be included in the query. The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have a key name less than or equal to the specified key.

You can read more about endAt() in Filtering data

サイン:

export declare function endAt(value: number | string | boolean | null, key?: string): QueryConstraint;

パラメーター

パラメータタイプ説明
価値number | string | boolean |ヌルThe value to end at. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
The child key to end at, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.

戻り値:

QueryConstraint

endBefore(value, key)

Creates a QueryConstraint with the specified ending point (exclusive).

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The ending point is exclusive. If only a value is provided, children with a value less than the specified value will be included in the query. If a key is specified, then children must have a value less than or equal to the specified value and a key name less than the specified key.

サイン:

export declare function endBefore(value: number | string | boolean | null, key?: string): QueryConstraint;

パラメーター

パラメータタイプ説明
価値number | string | boolean |ヌルThe value to end before. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
The child key to end before, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.

戻り値:

QueryConstraint

equalTo(value, key)

Creates a QueryConstraint that includes children that match the specified value.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have exactly the specified key as their key name. This can be used to filter result sets with many matches for the same value.

You can read more about equalTo() in Filtering data

サイン:

export declare function equalTo(value: number | string | boolean | null, key?: string): QueryConstraint;

パラメーター

パラメータタイプ説明
価値number | string | boolean |ヌルThe value to match for. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
The child key to start at, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.

戻り値:

QueryConstraint

startAfter(value, key)

Creates a QueryConstraint with the specified starting point (exclusive).

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The starting point is exclusive. If only a value is provided, children with a value greater than the specified value will be included in the query. If a key is specified, then children must have a value greater than or equal to the specified value and aa key name greater than the specified key.

サイン:

export declare function startAfter(value: number | string | boolean | null, key?: string): QueryConstraint;

パラメーター

パラメータタイプ説明
価値number | string | boolean |ヌルThe value to start after. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
The child key to start after. This argument is only allowed if ordering by child, value, or priority.

戻り値:

QueryConstraint

startAt(value, key)

Creates a QueryConstraint with the specified starting point.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The starting point is inclusive, so children with exactly the specified value will be included in the query. The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have a key name greater than or equal to the specified key.

You can read more about startAt() in Filtering data

サイン:

export declare function startAt(value?: number | string | boolean | null, key?: string): QueryConstraint;

パラメーター

パラメータタイプ説明
価値number | string | boolean |ヌルThe value to start at. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
The child key to start at. This argument is only allowed if ordering by child, value, or priority.

戻り値:

QueryConstraint

イベントタイプ

One of the following strings: "value", "child_added", "child_changed", "child_removed", or "child_moved."

サイン:

export declare type EventType = 'value' | 'child_added' | 'child_changed' | 'child_moved' | 'child_removed';

QueryConstraintType

Describes the different query constraints available in this SDK.

サイン:

export declare type QueryConstraintType = 'endAt' | 'endBefore' | 'startAt' | 'startAfter' | 'limitToFirst' | 'limitToLast' | 'orderByChild' | 'orderByKey' | 'orderByPriority' | 'orderByValue' | 'equalTo';

購読を解除する

A callback that can invoked to remove a listener.

サイン:

export declare type Unsubscribe = () => void;