database package

База данных Firebase в реальном времени

Функции

Функция	Описание
функция (приложение, ...)
getDatabase (приложение, URL)	Возвращает экземпляр SDK базы данных реального времени, связанный с предоставленным FirebaseApp. . Инициализирует новый экземпляр с настройками по умолчанию, если экземпляр не существует или если существующий экземпляр использует собственный URL-адрес базы данных.
функция(дб, ...)
ConnectDatabaseEmulator (база данных, хост, порт, параметры)	Измените предоставленный экземпляр для связи с эмулятором базы данных реального времени. Примечание. Этот метод необходимо вызывать перед выполнением любой другой операции.
goOffline(дб)	Отключается от сервера (все операции с базой данных будут выполняться в автономном режиме). Клиент автоматически поддерживает постоянное соединение с сервером базы данных, которое будет оставаться активным в течение неопределенного времени и повторно подключаться при отключении. Однако методы goOffline() и goOnline() могут использоваться для управления клиентским соединением в тех случаях, когда постоянное соединение нежелательно. В автономном режиме клиент больше не будет получать обновления данных из базы данных. Однако все операции с базой данных, выполняемые локально, будут продолжать немедленно генерировать события, позволяя вашему приложению продолжать работать в обычном режиме. Кроме того, каждая операция, выполняемая локально, автоматически ставится в очередь и повторяется при повторном подключении к серверу базы данных. Чтобы повторно подключиться к базе данных и начать получать удаленные события, см. goOnline() .
goOnline(дб)	Повторно подключается к серверу и синхронизирует автономное состояние базы данных с состоянием сервера. Этот метод следует использовать после отключения активного соединения с помощью goOffline() . После повторного подключения клиент передаст правильные данные и вызовет соответствующие события, чтобы ваш клиент автоматически «догнал».
ссылка (БД, путь)	Возвращает Reference , представляющую местоположение в базе данных, соответствующее указанному пути. Если путь не указан, Reference будет указывать на корень базы данных.
refFromURL(БД, URL)	Возвращает Reference , представляющую местоположение в базе данных, соответствующее предоставленному URL-адресу Firebase. Исключение выдается, если URL-адрес не является допустимым URL-адресом базы данных Firebase или имеет другой домен, чем текущий экземпляр Database . Обратите внимание, что все параметры запроса ( orderBy , limitToLast и т. д.) игнорируются и не применяются к возвращаемому Reference .
функция()
ForceLongPolling()	Принудительно использовать longPolling вместо веб-сокетов. Это будет проигнорировано, если в URL-адресе базы данных используется протокол веб-сокета.
ForceWebSockets()	Принудительно использовать веб-сокеты вместо longPolling.
заказ по ключу ()	Создает новый QueryConstraint , который упорядочивается по ключу. Сортирует результаты запроса по их (возрастающим) значениям ключей. Подробнее о orderByKey() можно прочитать в разделе Сортировка данных. .
заказ по приоритету()	Создает новый QueryConstraint , который упорядочивает по приоритету. Приложениям не обязательно использовать приоритет, но они могут упорядочивать коллекции по обычным свойствам (альтернативы приоритету см. в разделе Сортировка данных) .
заказпозначению()	Создает новый QueryConstraint , который упорядочивает по значению. Если все дочерние элементы запроса представляют собой скалярные значения (строковые, числовые или логические), вы можете упорядочить результаты по их (по возрастанию) значениям. Подробнее о orderByValue() можно прочитать в разделе Сортировка данных. .
серверTimestamp()	Возвращает значение-заполнитель для автоматического заполнения текущей отметки времени (время с эпохи Unix, в миллисекундах), определенное серверами Firebase.
функция(дельта, ...)
приращение (дельта)	Возвращает значение-заполнитель, которое можно использовать для атомарного увеличения текущего значения базы данных на указанную дельту.
функция(включена, ...)
EnableLogging (включено, постоянно)	Записывает отладочную информацию на консоль.
функция(предел, ...)
limitToFirst(ограничение)	Создает новый QueryConstraint , который ограничен первым конкретным количеством дочерних элементов. Метод limitToFirst() используется для установки максимального количества дочерних элементов, которые будут синхронизироваться для данного обратного вызова. Если мы установим ограничение в 100, изначально мы будем получать только до 100 событий child_added . Если в нашей базе данных хранится менее 100 сообщений, для каждого сообщения будет срабатывать событие child_added . Однако если у нас более 100 сообщений, мы получим событие child_added только для первых 100 заказанных сообщений. По мере изменения элементов мы будем получать события child_removed для каждого элемента, который выпадает из активного списка, так что общее количество остается равным 100. Подробнее о limitToFirst() можно прочитать в разделе Фильтрация данных. .
limitToLast(ограничение)	Создает новый QueryConstraint , который ограничен возвратом только последнего указанного количества дочерних элементов. Метод limitToLast() используется для установки максимального количества дочерних элементов, которые будут синхронизироваться для данного обратного вызова. Если мы установим ограничение в 100, изначально мы будем получать только до 100 событий child_added . Если в нашей базе данных хранится менее 100 сообщений, для каждого сообщения будет срабатывать событие child_added . Однако если у нас более 100 сообщений, мы получим событие child_added только для последних 100 заказанных сообщений. По мере изменения элементов мы будем получать события child_removed для каждого элемента, который выпадает из активного списка, так что общее количество остается равным 100. Подробнее о limitToLast() можно прочитать в разделе Фильтрация данных. .
функция (регистратор, ...)
EnableLogging (регистратор)	Записывает отладочную информацию на консоль.
функция(родитель, ...)
ребенок (родитель, путь)	Получает Reference на местоположение по указанному относительному пути. Относительный путь может быть либо простым дочерним именем (например, «ada»), либо более глубоким путем, разделенным косой чертой (например, «ada/name/first»).
push(родительский элемент, значение)	Генерирует новое дочернее местоположение, используя уникальный ключ, и возвращает его Reference . Это наиболее распространенный шаблон добавления данных в коллекцию элементов. Если вы предоставляете значение push() , оно записывается в сгенерированное место. Если вы не передаете значение, в базу данных ничего не записывается, и дочерний элемент остается пустым (но вы можете использовать Reference в другом месте). Уникальные ключи, сгенерированные функцией push() упорядочены по текущему времени, поэтому результирующий список элементов сортируется в хронологическом порядке. Ключи также спроектированы таким образом, чтобы их невозможно было угадать (они содержат 72 случайных бита энтропии). См. Добавление к списку данных. . См. 2^120 способов обеспечения уникальных идентификаторов. .
функция(путь, ...)
orderByChild (путь)	Создает новый QueryConstraint , который упорядочивается по указанному дочернему ключу. Запросы могут упорядочиваться только по одному ключу за раз. Вызов orderByChild() несколько раз для одного и того же запроса является ошибкой. Запросы Firebase позволяют вам упорядочивать данные по любому дочернему ключу на лету. Однако, если вы заранее знаете, какими будут ваши индексы, вы можете определить их с помощью правила .indexOn в своих правилах безопасности для повышения производительности. Дополнительную информацию см. в правиле https://firebase.google.com/docs/database/security/indexing-data . Подробнее о orderByChild() можно прочитать в разделе Сортировка данных. .
функция (запрос, ...)
получить (запрос)	Получает самый актуальный результат для этого запроса.
выключено (запрос, тип события, обратный вызов)	Отключает обратный вызов, ранее прикрепленный к соответствующему прослушивателю on () ( onValue , onChildAdded ). Примечание. Это не рекомендуемый способ удаления прослушивателя. Вместо этого используйте возвращаемую функцию обратного вызова из соответствующих on вызовов. Отсоедините обратный вызов, ранее прикрепленный с помощью on*() . Вызов off() для родительского прослушивателя не приведет к автоматическому удалению прослушивателей, зарегистрированных на дочерних узлах. off() также необходимо вызывать для любых дочерних прослушивателей, чтобы удалить обратный вызов. Если обратный вызов не указан, все обратные вызовы для указанного типа события будут удалены. Аналогично, если eventType не указан, все обратные вызовы для Reference будут удалены. Отдельные слушатели также могут быть удалены, вызвав их обратные вызовы для отказа от подписки.
onChildAdded (запрос, обратный вызов, отменаCallback)	Прослушивает изменения данных в определенном месте. Это основной способ чтения данных из базы данных. Ваш обратный вызов будет запускаться для исходных данных и снова при каждом изменении данных. Вызовите возвращенный обратный вызов отмены подписки, чтобы прекратить получение обновлений. Дополнительные сведения см. в разделе «Получение данных в Интернете» . Событие onChildAdded будет инициироваться один раз для каждого исходного дочернего элемента в этом месте и будет запускаться снова каждый раз при добавлении нового дочернего элемента. DataSnapshot переданный в обратный вызов, будет отражать данные для соответствующего дочернего элемента. В целях упорядочивания ему передается второй аргумент, который представляет собой строку, содержащую ключ предыдущего дочернего элемента в порядке сортировки или null , если это первый дочерний элемент.
onChildAdded (запрос, обратный вызов, параметры)	Прослушивает изменения данных в определенном месте. Это основной способ чтения данных из базы данных. Ваш обратный вызов будет запускаться для исходных данных и снова при каждом изменении данных. Вызовите возвращенный обратный вызов отмены подписки, чтобы прекратить получение обновлений. Дополнительные сведения см. в разделе «Получение данных в Интернете» . Событие onChildAdded будет инициироваться один раз для каждого исходного дочернего элемента в этом месте и будет запускаться снова каждый раз при добавлении нового дочернего элемента. DataSnapshot переданный в обратный вызов, будет отражать данные для соответствующего дочернего элемента. В целях упорядочивания ему передается второй аргумент, который представляет собой строку, содержащую ключ предыдущего дочернего элемента в порядке сортировки или null , если это первый дочерний элемент.
onChildAdded (запрос, обратный вызов, cancelCallback, параметры)	Прослушивает изменения данных в определенном месте. Это основной способ чтения данных из базы данных. Ваш обратный вызов будет запускаться для исходных данных и снова при каждом изменении данных. Вызовите возвращенный обратный вызов отмены подписки, чтобы прекратить получение обновлений. Дополнительные сведения см. в разделе «Получение данных в Интернете» . Событие onChildAdded будет инициироваться один раз для каждого исходного дочернего элемента в этом месте и будет запускаться снова каждый раз при добавлении нового дочернего элемента. DataSnapshot переданный в обратный вызов, будет отражать данные для соответствующего дочернего элемента. В целях упорядочивания ему передается второй аргумент, который представляет собой строку, содержащую ключ предыдущего дочернего элемента в порядке сортировки или null , если это первый дочерний элемент.
onChildChanged (запрос, обратный вызов, отмена обратного вызова)	Прослушивает изменения данных в определенном месте. Это основной способ чтения данных из базы данных. Ваш обратный вызов будет запускаться для исходных данных и снова при каждом изменении данных. Вызовите возвращенный обратный вызов отмены подписки, чтобы прекратить получение обновлений. Дополнительные сведения см. в разделе «Получение данных в Интернете» . Событие onChildChanged будет вызвано при изменении данных, хранящихся в дочернем элементе (или любом из его потомков). Обратите внимание, что одно событие child_changed может представлять несколько изменений дочернего элемента. DataSnapshot переданный обратному вызову, будет содержать новое дочернее содержимое. В целях упорядочивания обратному вызову также передается второй аргумент, который представляет собой строку, содержащую ключ предыдущего дочернего элемента в порядке сортировки или null , если это первый дочерний элемент.
onChildChanged (запрос, обратный вызов, параметры)	Прослушивает изменения данных в определенном месте. Это основной способ чтения данных из базы данных. Ваш обратный вызов будет запускаться для исходных данных и снова при каждом изменении данных. Вызовите возвращенный обратный вызов отмены подписки, чтобы прекратить получение обновлений. Дополнительные сведения см. в разделе «Получение данных в Интернете» . Событие onChildChanged будет вызвано при изменении данных, хранящихся в дочернем элементе (или любом из его потомков). Обратите внимание, что одно событие child_changed может представлять несколько изменений дочернего элемента. DataSnapshot переданный обратному вызову, будет содержать новое дочернее содержимое. В целях упорядочивания обратному вызову также передается второй аргумент, который представляет собой строку, содержащую ключ предыдущего дочернего элемента в порядке сортировки или null , если это первый дочерний элемент.
onChildChanged (запрос, обратный вызов, cancelCallback, параметры)	Прослушивает изменения данных в определенном месте. Это основной способ чтения данных из базы данных. Ваш обратный вызов будет запускаться для исходных данных и снова при каждом изменении данных. Вызовите возвращенный обратный вызов отмены подписки, чтобы прекратить получение обновлений. Дополнительные сведения см. в разделе «Получение данных в Интернете» . Событие onChildChanged будет вызвано при изменении данных, хранящихся в дочернем элементе (или любом из его потомков). Обратите внимание, что одно событие child_changed может представлять несколько изменений дочернего элемента. DataSnapshot переданный обратному вызову, будет содержать новое дочернее содержимое. В целях упорядочивания обратному вызову также передается второй аргумент, который представляет собой строку, содержащую ключ предыдущего дочернего элемента в порядке сортировки или null , если это первый дочерний элемент.
onChildMoved (запрос, обратный вызов, отменаCallback)	Прослушивает изменения данных в определенном месте. Это основной способ чтения данных из базы данных. Ваш обратный вызов будет запускаться для исходных данных и снова при каждом изменении данных. Вызовите возвращенный обратный вызов отмены подписки, чтобы прекратить получение обновлений. Дополнительные сведения см. в разделе «Получение данных в Интернете» . Событие onChildMoved будет вызвано, когда порядок сортировки дочернего элемента изменится так, что изменится его положение относительно своих братьев и сестер. DataSnapshot передаваемый обратному вызову, будет относиться к данным перемещенного дочернего элемента. Ему также передается второй аргумент, который представляет собой строку, содержащую ключ предыдущего дочернего элемента в порядке сортировки или null , если это первый дочерний элемент.
onChildMoved (запрос, обратный вызов, параметры)	Прослушивает изменения данных в определенном месте. Это основной способ чтения данных из базы данных. Ваш обратный вызов будет запускаться для исходных данных и снова при каждом изменении данных. Вызовите возвращенный обратный вызов отмены подписки, чтобы прекратить получение обновлений. Дополнительные сведения см. в разделе «Получение данных в Интернете» . Событие onChildMoved будет вызвано, когда порядок сортировки дочернего элемента изменится так, что изменится его положение относительно своих братьев и сестер. DataSnapshot передаваемый обратному вызову, будет относиться к данным перемещенного дочернего элемента. Ему также передается второй аргумент, который представляет собой строку, содержащую ключ предыдущего дочернего элемента в порядке сортировки или null , если это первый дочерний элемент.
onChildMoved (запрос, обратный вызов, cancelCallback, параметры)	Прослушивает изменения данных в определенном месте. Это основной способ чтения данных из базы данных. Ваш обратный вызов будет запускаться для исходных данных и снова при каждом изменении данных. Вызовите возвращенный обратный вызов отмены подписки, чтобы прекратить получение обновлений. Дополнительные сведения см. в разделе «Получение данных в Интернете» . Событие onChildMoved будет вызвано, когда порядок сортировки дочернего элемента изменится так, что изменится его положение относительно своих братьев и сестер. DataSnapshot передаваемый обратному вызову, будет относиться к данным перемещенного дочернего элемента. Ему также передается второй аргумент, который представляет собой строку, содержащую ключ предыдущего дочернего элемента в порядке сортировки или null , если это первый дочерний элемент.
onChildRemoved (запрос, обратный вызов, отменаCallback)	Прослушивает изменения данных в определенном месте. Это основной способ чтения данных из базы данных. Ваш обратный вызов будет запускаться для исходных данных и снова при каждом изменении данных. Вызовите возвращенный обратный вызов отмены подписки, чтобы прекратить получение обновлений. Дополнительные сведения см. в разделе «Получение данных в Интернете» . Событие onChildRemoved будет срабатывать один раз при каждом удалении дочернего элемента. DataSnapshot переданный в обратный вызов, будет старыми данными удаленного дочернего элемента. Ребенок будет удален, если: - клиент явно вызывает remove() для этого дочернего элемента или одного из его предков - клиент вызывает set(null) для этого дочернего элемента или одного из его предков - у этого дочернего элемента удалены все его дочерние элементы - действует запрос, который теперь отфильтровывает дочерний элемент (поскольку изменился порядок сортировки или был достигнут максимальный предел)
onChildRemoved (запрос, обратный вызов, параметры)	Прослушивает изменения данных в определенном месте. Это основной способ чтения данных из базы данных. Ваш обратный вызов будет запускаться для исходных данных и снова при каждом изменении данных. Вызовите возвращенный обратный вызов отмены подписки, чтобы прекратить получение обновлений. Дополнительные сведения см. в разделе «Получение данных в Интернете» . Событие onChildRemoved будет срабатывать один раз при каждом удалении дочернего элемента. DataSnapshot переданный в обратный вызов, будет старыми данными удаленного дочернего элемента. Ребенок будет удален, если: - клиент явно вызывает remove() для этого дочернего элемента или одного из его предков - клиент вызывает set(null) для этого дочернего элемента или одного из его предков - у этого дочернего элемента удалены все его дочерние элементы - действует запрос, который теперь отфильтровывает дочерний элемент (поскольку изменился порядок сортировки или был достигнут максимальный предел)
onChildRemoved (запрос, обратный вызов, cancelCallback, параметры)	Прослушивает изменения данных в определенном месте. Это основной способ чтения данных из базы данных. Ваш обратный вызов будет запускаться для исходных данных и снова при каждом изменении данных. Вызовите возвращенный обратный вызов отмены подписки, чтобы прекратить получение обновлений. Дополнительные сведения см. в разделе «Получение данных в Интернете» . Событие onChildRemoved будет срабатывать один раз при каждом удалении дочернего элемента. DataSnapshot переданный в обратный вызов, будет старыми данными удаленного дочернего элемента. Ребенок будет удален, если: - клиент явно вызывает remove() для этого дочернего элемента или одного из его предков - клиент вызывает set(null) для этого дочернего элемента или одного из его предков - у этого дочернего элемента удалены все его дочерние элементы - действует запрос, который теперь отфильтровывает дочерний элемент (поскольку изменился порядок сортировки или был достигнут максимальный предел)
onValue (запрос, обратный вызов, отмена обратного вызова)	Прослушивает изменения данных в определенном месте. Это основной способ чтения данных из базы данных. Ваш обратный вызов будет запускаться для исходных данных и снова при каждом изменении данных. Вызовите возвращенный обратный вызов отмены подписки, чтобы прекратить получение обновлений. Дополнительные сведения см. в разделе «Получение данных в Интернете» . Событие onValue сработает один раз с исходными данными, хранящимися в этом месте, а затем сработает снова каждый раз при изменении данных. DataSnapshot передаваемый обратному вызову, будет относиться к месту, в котором был вызван on() . Он не сработает, пока все содержимое не будет синхронизировано. Если в местоположении нет данных, оно будет запущено с пустым DataSnapshot ( val() вернет null ).
onValue (запрос, обратный вызов, параметры)	Прослушивает изменения данных в определенном месте. Это основной способ чтения данных из базы данных. Ваш обратный вызов будет запускаться для исходных данных и снова при каждом изменении данных. Вызовите возвращенный обратный вызов отмены подписки, чтобы прекратить получение обновлений. Дополнительные сведения см. в разделе «Получение данных в Интернете» . Событие onValue сработает один раз с исходными данными, хранящимися в этом месте, а затем сработает снова каждый раз при изменении данных. DataSnapshot передаваемый обратному вызову, будет относиться к месту, в котором был вызван on() . Он не сработает, пока все содержимое не будет синхронизировано. Если в местоположении нет данных, оно будет запущено с пустым DataSnapshot ( val() вернет null ).
onValue (запрос, обратный вызов, отмена обратного вызова, параметры)	Прослушивает изменения данных в определенном месте. Это основной способ чтения данных из базы данных. Ваш обратный вызов будет запускаться для исходных данных и снова при каждом изменении данных. Вызовите возвращенный обратный вызов отмены подписки, чтобы прекратить получение обновлений. Дополнительные сведения см. в разделе «Получение данных в Интернете» . Событие onValue сработает один раз с исходными данными, хранящимися в этом месте, а затем сработает снова каждый раз при изменении данных. DataSnapshot переданный обратному вызову, будет относиться к месту, в котором был вызван on() . Он не сработает, пока все содержимое не будет синхронизировано. Если в местоположении нет данных, оно будет запущено с пустым DataSnapshot ( val() вернет null ).
запрос (запрос, queryConstraints)	Создает новый неизменяемый экземпляр Query , который расширяется и включает дополнительные ограничения запроса.
функция(ссылка, ...)
onDisconnect (ссылка)	Возвращает объект OnDisconnect — дополнительную информацию о том, как его использовать, см. в разделе «Включение автономных возможностей в JavaScript» .
удалить (ссылка)	Удаляет данные в этом расположении базы данных. Любые данные в дочерних местоположениях также будут удалены. Эффект удаления будет виден немедленно, и будет вызвано соответствующее «значение» события. Также будет запущена синхронизация удаления с серверами Firebase, и возвращенное обещание будет разрешено после завершения. Если этот параметр указан, обратный вызов onComplete будет вызываться асинхронно после завершения синхронизации.
runTransaction (ссылка, транзакцияUpdate, параметры)	Атомарно изменяет данные в этом месте. Атомарно измените данные в этом месте. В отличие от обычного set() , который просто перезаписывает данные независимо от его предыдущего значения, runTransaction() используется для изменения существующего значения на новое, гарантируя отсутствие конфликтов с другими клиентами, записывающими в то же место в то же время. . Для этого вы передаете runTransaction() функцию обновления, которая используется для преобразования текущего значения в новое значение. Если другой клиент запишет это место до того, как ваше новое значение будет успешно записано, ваша функция обновления будет вызвана снова с новым текущим значением, и запись будет повторена. Это будет происходить неоднократно, пока ваша запись не завершится успешно без конфликтов или вы не прервете транзакцию, не вернув значение из функции обновления. Примечание. Изменение данных с помощью set() приведет к отмене любых ожидающих транзакций в этом месте, поэтому следует проявлять особую осторожность при смешивании set() и runTransaction() для обновления одних и тех же данных. Примечание. При использовании транзакций с установленными правилами безопасности и Firebase имейте в виду, что для выполнения транзакции клиенту требуется доступ .read в дополнение к доступу .write . Это связано с тем, что природа транзакций на стороне клиента требует, чтобы клиент читал данные для их транзакционного обновления.
установить (ссылка, значение)	Записывает данные в это местоположение базы данных. Это приведет к перезаписи любых данных в этом месте и во всех дочерних местоположениях. Эффект записи будет виден сразу, и будут вызваны соответствующие события («value», «child_added» и т. д.). Синхронизация данных с серверами Firebase также будет запущена, и возвращенное обещание будет разрешено после завершения. Если этот параметр указан, обратный вызов onComplete будет вызываться асинхронно после завершения синхронизации. Передача null для нового значения эквивалентна вызову remove() ; а именно, все данные в этом месте и всех дочерних местоположениях будут удалены. set() удалит любой приоритет, хранящийся в этом месте, поэтому, если приоритет должен быть сохранен, вам нужно вместо этого использовать setWithPriority() . Обратите внимание, что изменение данных с помощью set() приведет к отмене любых ожидающих транзакций в этом месте, поэтому следует проявлять особую осторожность при смешивании set() и transaction() для изменения одних и тех же данных. Один set() генерирует одно событие «value» в том месте, где был выполнен set() .
setPriority (ссылка, приоритет)	Устанавливает приоритет данных в этом расположении базы данных. Приложениям не обязательно использовать приоритет, но они могут упорядочивать коллекции по обычным свойствам (см. Сортировка и фильтрация данных ).
setWithPriority (ссылка, значение, приоритет)	Записывает данные в местоположение базы данных. Подобно set() , но также определяет приоритет этих данных. Приложениям не обязательно использовать приоритет, но они могут упорядочивать коллекции по обычным свойствам (см. Сортировка и фильтрация данных ).
обновление (ссылка, значения)	Записывает несколько значений в базу данных одновременно. Аргумент values содержит несколько пар свойство-значение, которые будут записаны в базу данных вместе. Каждое дочернее свойство может быть либо простым свойством (например, «имя»), либо относительным путем (например, «имя/первое») от текущего местоположения к обновляемым данным. В отличие от метода set() , update() можно использовать для выборочного обновления только свойств, на которые имеются ссылки, в текущем местоположении (вместо замены всех дочерних свойств в текущем местоположении). Эффект записи будет виден сразу, и будут вызваны соответствующие события («value», «child_added» и т. д.). Синхронизация данных с серверами Firebase также будет запущена, и возвращенное обещание будет разрешено после завершения. Если этот параметр указан, обратный вызов onComplete будет вызываться асинхронно после завершения синхронизации. Одиночное update() сгенерирует одно событие «значение» в том месте, где было выполнено update() , независимо от того, сколько дочерних элементов было изменено. Обратите внимание, что изменение данных с помощью update() приведет к отмене любых ожидающих транзакций в этом месте, поэтому следует проявлять крайнюю осторожность при смешивании update() и transaction() для изменения одних и тех же данных. Передача null в update() приведет к удалению данных в этом месте. См. раздел «Внедрение обновлений для нескольких местоположений» и многое другое. .
функция(значение, ...)
endAt(значение, ключ)	Создает QueryConstraint с указанной конечной точкой. Использование startAt() , startAfter() , endBefore() , endAt() и equalTo() позволяет вам выбирать произвольные начальную и конечную точки для ваших запросов. Конечная точка является инклюзивной, поэтому в запрос будут включены дочерние элементы с точно указанным значением. Необязательный аргумент ключа можно использовать для дальнейшего ограничения диапазона запроса. Если он указан, то дочерние элементы, имеющие точно указанное значение, также должны иметь имя ключа, меньшее или равное указанному ключу. Подробнее о endAt() можно прочитать в разделе Фильтрация данных. .
endBefore (значение, ключ)	Создает QueryConstraint с указанной конечной точкой (эксклюзивной). Использование startAt() , startAfter() , endBefore() , endAt() и equalTo() позволяет вам выбирать произвольные начальную и конечную точки для ваших запросов. Конечная точка является эксклюзивной. Если указано только значение, дочерние элементы со значением меньше указанного значения будут включены в запрос. Если указан ключ, то дочерние элементы должны иметь значение меньше или равное указанному значению и имя ключа меньше указанного ключа.
равноTo(значение, ключ)	Создает QueryConstraint , включающий дочерние элементы, соответствующие указанному значению. Использование startAt() , startAfter() , endBefore() , endAt() и equalTo() позволяет вам выбирать произвольные начальную и конечную точки для ваших запросов. Необязательный аргумент ключа можно использовать для дальнейшего ограничения диапазона запроса. Если он указан, то дочерние элементы, имеющие точно указанное значение, также должны иметь точно указанный ключ в качестве имени ключа. Это можно использовать для фильтрации наборов результатов со многими совпадениями для одного и того же значения. Вы можете прочитать больше о equalTo() в разделе Фильтрация данных. .
startAfter(значение, ключ)	Создает QueryConstraint с указанной начальной точкой (эксклюзивной). Использование startAt() , startAfter() , endBefore() , endAt() и equalTo() позволяет вам выбирать произвольные начальную и конечную точки для ваших запросов. Начальная точка является эксклюзивной. Если указано только значение, дочерние элементы со значением, превышающим указанное, будут включены в запрос. Если указан ключ, то дочерние элементы должны иметь значение, большее или равное указанному значению, и имя ключа, большее, чем указанный ключ.
startAt(значение, ключ)	Создает QueryConstraint с указанной начальной точкой. Использование startAt() , startAfter() , endBefore() , endAt() и equalTo() позволяет вам выбирать произвольные начальную и конечную точки для ваших запросов. Начальная точка является инклюзивной, поэтому в запрос будут включены дочерние элементы с точно указанным значением. Необязательный аргумент ключа можно использовать для дальнейшего ограничения диапазона запроса. Если он указан, то дочерние элементы, имеющие точно указанное значение, также должны иметь имя ключа, большее или равное указанному ключу. Подробнее о startAt() можно прочитать в разделе Фильтрация данных. .

Классы

Сорт	Описание
База данных	Класс, представляющий базу данных Firebase Realtime.
Снимок данных	DataSnapshot содержит данные из местоположения базы данных. Каждый раз, когда вы читаете данные из базы данных, вы получаете их в виде DataSnapshot . DataSnapshot передается в обратные вызовы событий, которые вы прикрепляете с помощью on() или once() . Вы можете извлечь содержимое снимка как объект JavaScript, вызвав метод val() . В качестве альтернативы вы можете перейти к снимку, вызвав child() для возврата дочерних снимков (которые затем можно вызвать val() ). DataSnapshot — это эффективно созданная неизменяемая копия данных в базе данных. Он не может быть изменен и никогда не изменится (чтобы изменить данные, вы всегда вызываете метод set() непосредственно Reference ).
При отключении	Класс onDisconnect позволяет вам записывать или очищать данные, когда ваш клиент отключается от сервера базы данных. Эти обновления происходят независимо от того, отключается ли ваш клиент корректно или нет, поэтому вы можете положиться на них в очистке данных даже в случае разрыва соединения или сбоя клиента. Класс onDisconnect чаще всего используется для управления присутствием в приложениях, где полезно определить, сколько клиентов подключено и когда другие клиенты отключаются. Дополнительную информацию см. в разделе «Включение автономных возможностей в JavaScript» . Чтобы избежать проблем, когда соединение разрывается до того, как запросы могут быть переданы на сервер базы данных, эти функции следует вызывать перед записью каких-либо данных. Обратите внимание, что операции onDisconnect запускаются только один раз. Если вы хотите, чтобы операция выполнялась каждый раз при отключении, вам потребуется повторно устанавливать операции onDisconnect каждый раз при повторном подключении.
Ограничение запроса	QueryConstraint используется для сужения набора документов, возвращаемых запросом к базе данных. QueryConstraint создаются путем вызова endAt(). , КонецПеред() , начатьВ() , стартПосле() , пределToFirst() , пределToLast() , заказПоребенку() , заказПоребенку() , orderByKey() , orderByPriority() , orderByValue() или равныхTo() и затем могут быть переданы в query() для создания нового экземпляра запроса, который также содержит этот QueryConstraint .
Результат транзакции	Тип значения разрешения runTransaction(). .

Интерфейсы

Интерфейс	Описание
База данныхСправочник	DatabaseReference представляет собой определенное местоположение в вашей базе данных и может использоваться для чтения или записи данных в это местоположение базы данных. Вы можете ссылаться на корневое или дочернее местоположение в вашей базе данных, вызывая ref() или ref("child/path") . Запись осуществляется с помощью метода set() , а чтение может выполняться с помощью метода on*() . См. https://firebase.google.com/docs/database/web/read-and-write .
Итерированный снимок данных	Представляет дочерний снимок Reference , по которой выполняется итерация. Ключ никогда не будет неопределенным.
Параметры прослушивания	Объекты параметров, которые можно использовать для настройки прослушивателя.
Запрос	Query сортирует и фильтрует данные в расположении базы данных, поэтому включается только подмножество дочерних данных. Это можно использовать для упорядочивания сбора данных по какому-либо атрибуту (например, высоте динозавров), а также для ограничения большого списка элементов (например, сообщений чата) до количества, подходящего для синхронизации с клиентом. Запросы создаются путем объединения одного или нескольких методов фильтра, определенных здесь. Как и в случае с DatabaseReference , вы можете получать данные из Query используя методы on*() . Вы будете получать события и DataSnapshot только для того подмножества данных, которое соответствует вашему запросу. См. https://firebase.google.com/docs/database/web/lists-of-data#sorting_and_filtering_data для получения дополнительной информации.
Тогдааблессылка	Promise , которое также может выступать в качестве DatabaseReference при возврате методом push(). . Ссылка доступна немедленно, а Promise разрешается по завершении записи на серверную часть.
Параметры транзакции	Объект параметров для настройки транзакций.

Введите псевдонимы

Введите псевдоним	Описание
тип события	Одна из следующих строк: «value», «child_added», «child_changed», «child_removed» или «child_moved».
QueryConstraintType	Описывает различные ограничения запросов, доступные в этом SDK.
Отписаться	Обратный вызов, который можно вызвать для удаления прослушивателя.

функция (приложение, ...)

getDatabase (приложение, URL)

Возвращает экземпляр SDK базы данных реального времени, связанный с предоставленным FirebaseApp. . Инициализирует новый экземпляр с настройками по умолчанию, если экземпляр не существует или если существующий экземпляр использует собственный URL-адрес базы данных.

Подпись:

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

Параметры

Параметр	Тип	Описание
приложение	FirebaseApp	Экземпляр Firebaseapp , с которым связан возвращенный экземпляр базы данных в реальном времени.
URL	нить	URL -адрес экземпляра базы данных в реальном времени для подключения. Если не предоставлено, SDK подключается к экземпляру по умолчанию приложения Firebase.

Возврат:

База данных

Экземпляр Database предоставленного приложения.

функция (дБ, ...)

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 (дБ)

Воспитание с сервером и синхронизирует состояние автономной базы данных с состоянием сервера.

Этот метод следует использовать после отключения активного соединения с goOffline() . После повторного подключения клиент будет передавать соответствующие данные и запустить соответствующие события, чтобы ваш клиент «автоматически догнал».

Подпись:

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

Параметры

Параметр	Тип	Описание
БД	База данных	Экземпляр воссоединить.

Возврат:

пустота

ref (дБ, путь)

Возвращает Reference , представляющую местоположение в базе данных, соответствующее предоставленному пути. Если путь не будет предоставлен, Reference будет указывать на корень базы данных.

Подпись:

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

Параметры

Параметр	Тип	Описание
БД	База данных	Экземпляр базы данных для получения ссылки для.
путь	нить	Необязательный путь, представляющий местоположение, указывает возвращенная Reference . Если не предоставлено, возвращенная Reference будет указывать на корень базы данных.

Возврат:

База данных

Если путь предоставлен, Reference , указывающая на предоставленный путь. В противном случае Reference , указывающая на корень базы данных.

reffromurl (db, url)

Возвращает Reference , представляющую местоположение в базе данных, соответствующее предоставленному URL -адресу Firebase.

Исключение выдвигается, если URL не является действительным URL -адресом базы данных Firebase или имеет другой домен, чем текущий экземпляр Database .

Обратите внимание, что все параметры запроса ( orderBy , limitToLast и т. д.) игнорируются и не применяются к возвращенной Reference .

Подпись:

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

Параметры

Параметр	Тип	Описание
БД	База данных	Экземпляр базы данных для получения ссылки для.
URL	нить	URL Firebase, на котором будет указывать возвращенная Reference .

Возврат:

База данных

Reference , указывающая на предоставленный URL -адрес Firebase.

функция()

forcelongpolling ()

Заставьте использование длинного точка вместо веб -кокеты. Это будет проигнорировано, если протокол WebSocket используется в базе данных.

Подпись:

export declare function forceLongPolling(): void;

Возврат:

пустота

ForceWebsockets ()

Заставьте использование веб -питания вместо длинного точка.

Подпись:

export declare function forceWebSockets(): void;

Возврат:

пустота

orderbykey ()

Создает новый QueryConstraint , который заказывает ключ.

Сортирует результаты запроса по их (восходящим) значениям ключей.

Вы можете прочитать больше о orderByKey() в сортировке данных .

Подпись:

export declare function orderByKey(): QueryConstraint;

Возврат:

QueryConstraint

orderbypriority ()

Создает новый QueryConstraint , который заказывает приоритетом.

Приложения не должны использовать приоритет, но могут заказать коллекции с помощью обычных свойств (см. Сортировку данных для альтернатив приоритету.

Подпись:

export declare function orderByPriority(): QueryConstraint;

Возврат:

QueryConstraint

orderbyvalue ()

Создает новый QueryConstraint , который заказывает по цене.

Если все дети запроса - все это скалярные значения (строка, число или логическое), вы можете заказать результаты по их (восходящим) значениям.

Вы можете прочитать больше о orderByValue() в сортировке данных .

Подпись:

export declare function orderByValue(): QueryConstraint;

Возврат:

QueryConstraint

servertimestamp ()

Возвращает значение заполнителя для автоматической заполнения текущей метки времени (время с момента эпохи UNIX, в миллисекундах), как определено серверами пожарной базы.

Подпись:

export declare function serverTimestamp(): object;

Возврат:

объект

Функция (Дельта, ...)

Приращение (Дельта)

Возвращает значение заполнителя, которое можно использовать для атомно -увеличения текущего значения базы данных предоставленной Delta.

Подпись:

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

Параметры

Параметр	Тип	Описание
дельта	число	Сумма для изменения текущего значения атомно.

Возврат:

объект

Значение заполнителя для изменения данных атомно-сервера.

функция (включена, ...)

eNabLeLogging (включено, постоянное)

Журналы отладки информации в консоли.

Подпись:

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

Параметры

Параметр	Тип	Описание
включено	логическое значение	Включает регистрацию, если true , отключает ведение журнала, если false .
настойчивый	логическое значение	Помнит состояние журнала между обновлениями страницы, если true .

Возврат:

любой

функция (предел, ...)

LimittoFirst (Limit)

Создает новый QueryConstraint , который, если ограничен первым конкретным количеством детей.

Метод limitToFirst() используется для установки максимального количества детей, которые должны синхронизироваться для данного обратного вызова. Если мы установим предел 100, мы первоначально получим до 100 child_added . Если у нас есть менее 100 сообщений, хранящихся в нашей базе данных, событие child_added будет стрелять для каждого сообщения. Однако, если у нас будет более 100 сообщений, мы получим событие child_added только для первых 100 заказанных сообщений. По мере изменения элементов мы будем получать события child_removed для каждого элемента, который выпадает из активного списка, так что общее число остается на уровне 100.

Вы можете прочитать больше о limitToFirst() в данных фильтрации .

Подпись:

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

Параметры

Параметр	Тип	Описание
предел	число	Максимальное количество узлов для включения в этот запрос.

Возврат:

QueryConstraint

Limittolast (предел)

Создает новый QueryConstraint , которая ограничена для возврата только последнего указанного количества детей.

Метод limitToLast() используется для установки максимального количества детей, которые должны синхронизироваться для данного обратного вызова. Если мы установим предел 100, мы первоначально получим до 100 child_added . Если у нас есть менее 100 сообщений, хранящихся в нашей базе данных, событие child_added будет стрелять для каждого сообщения. Однако, если у нас будет более 100 сообщений, мы получим событие child_added только для последних 100 заказанных сообщений. По мере изменения элементов мы будем получать события child_removed для каждого элемента, который выпадает из активного списка, так что общее число остается на уровне 100.

Вы можете прочитать больше о limitToLast() в данных фильтрации .

Подпись:

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

Параметры

Параметр	Тип	Описание
предел	число	Максимальное количество узлов для включения в этот запрос.

Возврат:

QueryConstraint

функция (регистратор, ...)

EnableLogging (logger)

Журналы отладки информации в консоли.

Подпись:

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

Параметры

Параметр	Тип	Описание
лесоруб	(Сообщение: String) => Неизвестно	Пользовательская функция регистратора для управления тем, как все регистрируется.

Возврат:

любой

функция (родитель, ...)

ребенок (родитель, путь)

Получает Reference на местоположение на указанном относительном пути.

Относительным путем может быть либо простое имя ребенка (например, «ADA»), либо более глубоким путем, разделенным SLASH (например, «ADA/name/First»).

Подпись:

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

Параметры

Параметр	Тип	Описание
родитель	База данных	Родительское местоположение.
путь	нить	Относительный путь от этого места до желаемого дочернего местоположения.

Возврат:

База данных

Указанное дочернее местоположение.

push (родитель, значение)

Генерирует новое дочернее местоположение, используя уникальный ключ и возвращает свою Reference .

Это наиболее распространенный шаблон для добавления данных в набор элементов.

Если вы предоставите значение для push() , значение записывается в сгенерированное место. Если вы не передаете значение, в базу данных ничего не записано, и ребенок остается пустым (но вы можете использовать Reference в другом месте).

Уникальные ключи, сгенерированные push() упорядочены текущим временем, поэтому полученный список элементов хронологически отсортируется. Ключи также предназначены для того, чтобы быть неуязвимыми (они содержат 72 случайных бита энтропии).

См. Приложение к списку данных . См. 2^120 способов обеспечения уникальных идентификаторов .

Подпись:

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

Параметры

Параметр	Тип	Описание
родитель	База данных	Родительское местоположение.
ценить	неизвестный	Необязательное значение, которое будет записано в сгенерированном месте.

Возврат:

Затем

Объединенное Promise и Reference ; Разрешается, когда запись завершена, но может быть использовано немедленно в качестве Reference на дочерние местоположение.

функция (путь, ...)

orderbychild (путь)

Создает новую QueryConstraint , которая приказывает указанным дочерним ключам.

Запросы могут заказать только по одному ключу за раз. Вызов orderByChild() несколько раз по одному и тому же запросу является ошибкой.

Запросы Firebase позволяют заказать ваши данные любым дочерним ключом на лету. Однако, если вы заранее знаете, какими будут ваши индексы, вы можете определить их через правило .indexon в правилах безопасности для повышения производительности. См . Https://firebase.google.com/docs/database/security/indexing-data для получения дополнительной информации.

Вы можете прочитать больше о orderByChild() в сортировке данных .

Подпись:

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

Параметры

Параметр	Тип	Описание
путь	нить	Путь к заказу.

Возврат:

QueryConstraint

функция (запрос, ...)

получить (запрос)

Получает самый современный результат для этого запроса.

Подпись:

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

Параметры

Параметр	Тип	Описание
запрос	Запрос	Запрос для выполнения.

Возврат:

Обещание < datasnapshot >

Promise , которое разрешается полученным данным DataSnapShot, если значение доступно, или отклоняется, если клиент не может вернуть значение (например, если сервер недоступен и ничего кэшируется).

OFF (Query, EventType, обратный вызов)

Отмечает обратный вызов, ранее прикрепленный с соответствующим 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;

Параметры

Параметр	Тип	Описание
запрос	Запрос	Запрос, в котором был зарегистрирован слушатель.
EventType	EventType	Одна из следующих строк: «Значение», «child_added», «Child_changed», «Child_removed» или «Child_moved». Если опущены, все обратные вызовы для Reference будут удалены.
перезвонить	(Снимок: DataSnapShot , предыдущий кольцо?: Строка | null) => неизвестно	Функция обратного вызова, которая была передана on() или undefined , чтобы удалить все обратные вызовы.

Возврат:

пустота

Onchildadded (запрос, обратный вызов, CancelCallback)

Слушает изменения данных в определенном месте.

Это основной способ прочитать данные из базы данных. Ваш обратный вызов будет запускается для начальных данных и снова, когда данные будут изменяться. Вызвать возвращаемый вызов отказа от подписки, чтобы прекратить получать обновления. См. Получите данные в Интернете для получения более подробной информации.

Событие onChildAdded будет вызвано один раз для каждого начального ребенка в этом месте, и оно будет запускаться снова каждый раз, когда добавляется новый ребенок. DataSnapshot переданный в обратный вызов, будет отражать данные для соответствующего ребенка. Для целей заказа его передается второй аргумент, который является строкой, содержащей ключ предыдущего брата -брата по порядку сортировки, или null , если это первый ребенок.

Подпись:

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

Параметры

Параметр	Тип	Описание
запрос	Запрос	Запрос для выполнения.
перезвонить	(Снимок: DataSnapShot , предыдущий кольцо?: Строка | null) => неизвестно	Обратный вызов, который стреляет, когда происходит указанное событие. Обратный вызов будет передаваться на DataSnapShot и строку, содержащую ключ предыдущего ребенка, по заказу сортировки или null , если это первый ребенок.
CancelCallback	(ошибка: ошибка) => неизвестно	Необязательный обратный вызов, который будет уведомлен, если подписка на ваше событие будет отменено, потому что ваш клиент не имеет разрешения на чтение этих данных (или у нее было разрешение, но теперь потеряло их). Этот обратный вызов будет передан объекту Error , указывающий, почему произошел сбой.

Возврат:

Отписаться

Функция, которая может быть вызвана для удаления слушателя.

Onchildadded (запрос, обратный вызов, параметры)

Слушает изменения данных в определенном месте.

Это основной способ прочитать данные из базы данных. Ваш обратный вызов будет запускается для начальных данных и снова, когда данные будут изменяться. Вызвать возвращаемый вызов отказа от подписки, чтобы прекратить получать обновления. См. Получите данные в Интернете для получения более подробной информации.

Событие onChildAdded будет вызвано один раз для каждого начального ребенка в этом месте, и оно будет запускаться снова каждый раз, когда добавляется новый ребенок. DataSnapshot переданный в обратный вызов, будет отражать данные для соответствующего ребенка. Для целей заказа его передается второй аргумент, который является строкой, содержащей ключ предыдущего брата -брата по порядку сортировки, или null , если это первый ребенок.

Подпись:

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

Параметры

Параметр	Тип	Описание
запрос	Запрос	Запрос для выполнения.
перезвонить	(Снимок: DataSnapShot , предыдущая чаевые: String | null) => неизвестно	Обратный вызов, который стреляет, когда происходит указанное событие. Обратный вызов будет передаваться на DataSnapShot и строку, содержащую ключ предыдущего ребенка, по заказу сортировки или null , если это первый ребенок.
параметры	Слушайте	Объект, который можно использовать для настройки onlyOnce , который затем удаляет слушателя после первого вызова.

Возврат:

Отписаться

Функция, которая может быть вызвана для удаления слушателя.

Onchildadded (запрос, обратный вызов, CancelCallback, Options)

Слушает изменения данных в определенном месте.

Это основной способ прочитать данные из базы данных. Ваш обратный вызов будет запускается для начальных данных и снова, когда данные будут изменяться. Вызвать возвращаемый вызов отказа от подписки, чтобы прекратить получать обновления. См. Получите данные в Интернете для получения более подробной информации.

Событие onChildAdded будет вызвано один раз для каждого начального ребенка в этом месте, и оно будет запускаться снова каждый раз, когда добавляется новый ребенок. DataSnapshot переданный в обратный вызов, будет отражать данные для соответствующего ребенка. Для целей заказа его передается второй аргумент, который является строкой, содержащей ключ предыдущего брата -брата по порядку сортировки, или null , если это первый ребенок.

Подпись:

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

Параметры

Параметр	Тип	Описание
запрос	Запрос	Запрос для выполнения.
перезвонить	(Снимок: DataSnapShot , предыдущая чаевые: String | null) => неизвестно	Обратный вызов, который стреляет, когда происходит указанное событие. Обратный вызов будет передаваться на DataSnapShot и строку, содержащую ключ предыдущего ребенка, по заказу сортировки или null , если это первый ребенок.
CancelCallback	(ошибка: ошибка) => неизвестно	Необязательный обратный вызов, который будет уведомлен, если подписка на ваше событие будет отменено, потому что ваш клиент не имеет разрешения на чтение этих данных (или у нее было разрешение, но теперь потеряло их). Этот обратный вызов будет передан объекту Error , указывающий, почему произошел сбой.
параметры	Слушайте	Объект, который можно использовать для настройки onlyOnce , который затем удаляет слушателя после первого вызова.

Возврат:

Отписаться

Функция, которая может быть вызвана для удаления слушателя.

OnChildChanged (запрос, обратный вызов, CancelCallback)

Слушает изменения данных в определенном месте.

Это основной способ прочитать данные из базы данных. Ваш обратный вызов будет запускается для начальных данных и снова, когда данные будут изменяться. Вызвать возвращаемый вызов отказа от подписки, чтобы прекратить получать обновления. См. Получите данные в Интернете для получения более подробной информации.

Событие onChildChanged будет вызвано при изменении данных, хранящихся у ребенка (или любого из его потомков). Обратите внимание, что одно событие для одного child_changed может представлять множество изменений в ребенке. DataSnapshot переданный в обратный вызов, будет содержать новое содержимое ребенка. В целях заказа обратный вызов также передается вторым аргументом, который является строкой, содержащей ключ предыдущего ребенка брата по сортировке, или null если это первый ребенок.

Подпись:

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

Параметры

Параметр	Тип	Описание
запрос	Запрос	Запрос для выполнения.
перезвонить	(Снимок: DataSnapShot , предыдущая чаевые: String | null) => неизвестно	Обратный вызов, который стреляет, когда происходит указанное событие. Обратный вызов будет передаваться на DataSnapShot и строку, содержащую ключ предыдущего ребенка, по заказу сортировки или null , если это первый ребенок.
CancelCallback	(ошибка: ошибка) => неизвестно	Необязательный обратный вызов, который будет уведомлен, если подписка на ваше событие будет отменено, потому что ваш клиент не имеет разрешения на чтение этих данных (или у нее было разрешение, но теперь потеряло их). Этот обратный вызов будет передан объекту Error , указывающий, почему произошел сбой.

Возврат:

Отписаться

Функция, которая может быть вызвана для удаления слушателя.

OnChildChanged (запрос, обратный вызов, варианты)

Слушает изменения данных в определенном месте.

Это основной способ прочитать данные из базы данных. Ваш обратный вызов будет запускается для начальных данных и снова, когда данные будут изменяться. Вызвать возвращаемый вызов отказа от подписки, чтобы прекратить получать обновления. См. Получите данные в Интернете для получения более подробной информации.

Событие onChildChanged будет вызвано при изменении данных, хранящихся у ребенка (или любого из его потомков). Обратите внимание, что одно событие для одного child_changed может представлять множество изменений в ребенке. DataSnapshot переданный в обратный вызов, будет содержать новое содержимое ребенка. В целях заказа обратный вызов также передается вторым аргументом, который является строкой, содержащей ключ предыдущего ребенка брата по сортировке, или null если это первый ребенок.

Подпись:

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

Параметры

Параметр	Тип	Описание
запрос	Запрос	Запрос для выполнения.
перезвонить	(Снимок: DataSnapShot , предыдущая чаевые: String | null) => неизвестно	Обратный вызов, который стреляет, когда происходит указанное событие. Обратный вызов будет передаваться на DataSnapShot и строку, содержащую ключ предыдущего ребенка, по заказу сортировки или null , если это первый ребенок.
параметры	Слушайте	Объект, который можно использовать для настройки onlyOnce , который затем удаляет слушателя после первого вызова.

Возврат:

Отписаться

Функция, которая может быть вызвана для удаления слушателя.

OnChildChanged (запрос, обратный вызов, CancelCallback, Options)

Слушает изменения данных в определенном месте.

Это основной способ прочитать данные из базы данных. Ваш обратный вызов будет запускается для начальных данных и снова, когда данные будут изменяться. Вызвать возвращаемый вызов отказа от подписки, чтобы прекратить получать обновления. См. Получите данные в Интернете для получения более подробной информации.

Событие onChildChanged будет вызвано при изменении данных, хранящихся у ребенка (или любого из его потомков). Обратите внимание, что одно событие для одного child_changed может представлять множество изменений в ребенке. DataSnapshot переданный в обратный вызов, будет содержать новое содержимое ребенка. В целях заказа обратный вызов также передается вторым аргументом, который является строкой, содержащей ключ предыдущего ребенка брата по сортировке, или null если это первый ребенок.

Подпись:

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

Параметры

Параметр	Тип	Описание
запрос	Запрос	Запрос для выполнения.
перезвонить	(Снимок: DataSnapShot , предыдущая чаевые: String | null) => неизвестно	Обратный вызов, который стреляет, когда происходит указанное событие. Обратный вызов будет передаваться на DataSnapShot и строку, содержащую ключ предыдущего ребенка, по заказу сортировки или null , если это первый ребенок.
CancelCallback	(ошибка: ошибка) => неизвестно	Необязательный обратный вызов, который будет уведомлен, если подписка на ваше событие будет отменено, потому что ваш клиент не имеет разрешения на чтение этих данных (или у нее было разрешение, но теперь потеряло их). Этот обратный вызов будет передан объекту Error , указывающий, почему произошел сбой.
параметры	Слушайте	Объект, который можно использовать для настройки onlyOnce , который затем удаляет слушателя после первого вызова.

Возврат:

Отписаться

Функция, которая может быть вызвана для удаления слушателя.

OnChildMoved (запрос, обратный вызов, CancelCallback)

Слушает изменения данных в определенном месте.

Это основной способ прочитать данные из базы данных. Ваш обратный вызов будет запускается для начальных данных и снова, когда данные будут изменяться. Вызвать возвращаемый вызов отказа от подписки, чтобы прекратить получать обновления. См. Получите данные в Интернете для получения более подробной информации.

Событие onChildMoved будет вызвано при изменении порядок сортировки ребенка, так что его положение относительно изменений его братьев и сестер. DataSnapshot переданный к обратному обращению, будет предназначаться для данных переехала ребенка. Это также передается второй аргумент, который является строкой, содержащей ключ предыдущего брата -брата по порядку сортировки, или null , если это первый ребенок.

Подпись:

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

Параметры

Параметр	Тип	Описание
запрос	Запрос	Запрос для выполнения.
перезвонить	(Снимок: DataSnapShot , предыдущая чаевые: String | null) => неизвестно	Обратный вызов, который стреляет, когда происходит указанное событие. Обратный вызов будет передаваться на DataSnapShot и строку, содержащую ключ предыдущего ребенка, по заказу сортировки или null , если это первый ребенок.
CancelCallback	(ошибка: ошибка) => неизвестно	Необязательный обратный вызов, который будет уведомлен, если подписка на ваше событие будет отменено, потому что ваш клиент не имеет разрешения на чтение этих данных (или у нее было разрешение, но теперь потеряло их). Этот обратный вызов будет передан объекту Error , указывающий, почему произошел сбой.

Возврат:

Отписаться

Функция, которая может быть вызвана для удаления слушателя.

OnChildMoved (запрос, обратный вызов, варианты)

Слушает изменения данных в определенном месте.

Это основной способ прочитать данные из базы данных. Ваш обратный вызов будет запускается для начальных данных и снова, когда данные будут изменяться. Вызвать возвращаемый вызов отказа от подписки, чтобы прекратить получать обновления. См. Получите данные в Интернете для получения более подробной информации.

Событие onChildMoved будет вызвано при изменении порядок сортировки ребенка, так что его положение относительно изменений его братьев и сестер. DataSnapshot переданный к обратному обращению, будет предназначаться для данных переехала ребенка. Это также передается второй аргумент, который является строкой, содержащей ключ предыдущего брата -брата по порядку сортировки, или null , если это первый ребенок.

Подпись:

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

Параметры

Параметр	Тип	Описание
запрос	Запрос	Запрос для выполнения.
перезвонить	(Снимок: DataSnapShot , предыдущая чаевые: String | null) => неизвестно	Обратный вызов, который стреляет, когда происходит указанное событие. Обратный вызов будет передаваться на DataSnapShot и строку, содержащую ключ предыдущего ребенка, по заказу сортировки или null , если это первый ребенок.
параметры	Слушайте	Объект, который можно использовать для настройки onlyOnce , который затем удаляет слушателя после первого вызова.

Возврат:

Отписаться

Функция, которая может быть вызвана для удаления слушателя.

OnChildMoved (запрос, обратный вызов, CancelCallback, Options)

Слушает изменения данных в определенном месте.

Это основной способ прочитать данные из базы данных. Ваш обратный вызов будет запускается для начальных данных и снова, когда данные будут изменяться. Вызвать возвращаемый вызов отказа от подписки, чтобы прекратить получать обновления. См. Получите данные в Интернете для получения более подробной информации.

Событие onChildMoved будет вызвано при изменении порядок сортировки ребенка, так что его положение относительно изменений его братьев и сестер. DataSnapshot переданный к обратному обращению, будет предназначаться для данных переехала ребенка. Это также передается второй аргумент, который является строкой, содержащей ключ предыдущего брата -брата по порядку сортировки, или null , если это первый ребенок.

Подпись:

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

Параметры

Параметр	Тип	Описание
запрос	Запрос	Запрос для выполнения.
перезвонить	(Снимок: DataSnapShot , предыдущая чаевые: String | null) => неизвестно	Обратный вызов, который стреляет, когда происходит указанное событие. Обратный вызов будет передаваться на DataSnapShot и строку, содержащую ключ предыдущего ребенка, по заказу сортировки или null , если это первый ребенок.
CancelCallback	(ошибка: ошибка) => неизвестно	Необязательный обратный вызов, который будет уведомлен, если подписка на ваше событие будет отменено, потому что ваш клиент не имеет разрешения на чтение этих данных (или у нее было разрешение, но теперь потеряло их). Этот обратный вызов будет передан объекту Error , указывающий, почему произошел сбой.
параметры	Слушайте	Объект, который можно использовать для настройки onlyOnce , который затем удаляет слушателя после первого вызова.

Возврат:

Отписаться

Функция, которая может быть вызвана для удаления слушателя.

OnChildRemoved (запрос, обратный вызов, CancelCallback)

Слушает изменения данных в определенном месте.

Это основной способ прочитать данные из базы данных. Ваш обратный вызов будет запускается для начальных данных и снова, когда данные будут изменяться. Вызвать возвращаемый вызов отказа от подписки, чтобы прекратить получать обновления. См. Получите данные в Интернете для получения более подробной информации.

Событие onChildRemoved будет вызвано один раз каждый раз, когда ребенок будет удален. DataSnapshot переданный в обратный вызов, станут старыми данными для ребенка, который был удален. Ребенок будет удален, когда либо:

• Клиент явно remove() на этого ребенка или одного из его предков - клиент -звонки set(null) на этого ребенка или одного из его предков - что ребенок удален всех детей - есть запрос, который сейчас фильтры вне ребенка (потому что порядок сортировки изменился или максимальный предел был поражен)

Подпись:

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

Параметры

Параметр	Тип	Описание
запрос	Запрос	Запрос для выполнения.
перезвонить	(Снимок: DataSnapShot ) => неизвестно	Обратный вызов, который стреляет, когда происходит указанное событие. Обратный вызов будет передаваться на DataSnapShot и строку, содержащую ключ предыдущего ребенка, по заказу сортировки или null , если это первый ребенок.
CancelCallback	(ошибка: ошибка) => неизвестно	Необязательный обратный вызов, который будет уведомлен, если подписка на ваше событие будет отменено, потому что ваш клиент не имеет разрешения на чтение этих данных (или у нее было разрешение, но теперь потеряло их). Этот обратный вызов будет передан объекту Error , указывающий, почему произошел сбой.

Возврат:

Отписаться

Функция, которая может быть вызвана для удаления слушателя.

OnChildRemoved (запрос, обратный вызов, варианты)

Слушает изменения данных в определенном месте.

Это основной способ прочитать данные из базы данных. Ваш обратный вызов будет запускается для начальных данных и снова, когда данные будут изменяться. Вызвать возвращаемый вызов отказа от подписки, чтобы прекратить получать обновления. См. Получите данные в Интернете для получения более подробной информации.

Событие onChildRemoved будет вызвано один раз каждый раз, когда ребенок будет удален. DataSnapshot переданный в обратный вызов, станут старыми данными для ребенка, который был удален. Ребенок будет удален, когда либо:

• Клиент явно remove() на этого ребенка или одного из его предков - клиент -звонки set(null) на этого ребенка или одного из его предков - что ребенок удален всех детей - есть запрос, который сейчас фильтры вне ребенка (потому что порядок сортировки изменился или максимальный предел был поражен)

Подпись:

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

Параметры

Параметр	Тип	Описание
запрос	Запрос	Запрос для выполнения.
перезвонить	(Снимок: DataSnapShot ) => неизвестно	Обратный вызов, который стреляет, когда происходит указанное событие. Обратный вызов будет передаваться на DataSnapShot и строку, содержащую ключ предыдущего ребенка, по заказу сортировки или null , если это первый ребенок.
параметры	Слушайте	Объект, который можно использовать для настройки onlyOnce , который затем удаляет слушателя после первого вызова.

Возврат:

Отписаться

Функция, которая может быть вызвана для удаления слушателя.

OnChildRemoved (запрос, обратный вызов, CancelCallback, Options)

Слушает изменения данных в определенном месте.

Это основной способ прочитать данные из базы данных. Ваш обратный вызов будет запускается для начальных данных и снова, когда данные будут изменяться. Вызвать возвращаемый вызов отказа от подписки, чтобы прекратить получать обновления. См. Получите данные в Интернете для получения более подробной информации.

Событие onChildRemoved будет вызвано один раз каждый раз, когда ребенок будет удален. DataSnapshot переданный в обратный вызов, станут старыми данными для ребенка, который был удален. Ребенок будет удален, когда либо:

• Клиент явно remove() на этого ребенка или одного из его предков - клиент -звонки set(null) на этого ребенка или одного из его предков - что ребенок удален всех детей - есть запрос, который сейчас фильтры вне ребенка (потому что порядок сортировки изменился или максимальный предел был поражен)

Подпись:

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

Параметры

Параметр	Тип	Описание
запрос	Запрос	Запрос для выполнения.
перезвонить	(Снимок: DataSnapShot ) => неизвестно	Обратный вызов, который стреляет, когда происходит указанное событие. Обратный вызов будет передаваться на DataSnapShot и строку, содержащую ключ предыдущего ребенка, по заказу сортировки или null , если это первый ребенок.
CancelCallback	(ошибка: ошибка) => неизвестно	Необязательный обратный вызов, который будет уведомлен, если подписка на ваше событие будет отменено, потому что ваш клиент не имеет разрешения на чтение этих данных (или у нее было разрешение, но теперь потеряло их). Этот обратный вызов будет передан объекту Error , указывающий, почему произошел сбой.
параметры	Слушайте	Объект, который можно использовать для настройки onlyOnce , который затем удаляет слушателя после первого вызова.

Возврат:

Отписаться

Функция, которая может быть вызвана для удаления слушателя.

OnValue (запрос, обратный вызов, CancelCallback)

Слушает изменения данных в определенном месте.

Это основной способ прочитать данные из базы данных. Ваш обратный вызов будет запускается для начальных данных и снова, когда данные будут изменяться. Вызвать возвращаемый вызов отказа от подписки, чтобы прекратить получать обновления. См. Получите данные в Интернете для получения более подробной информации.

Событие onValue будет запускать один раз с начальными данными, хранящимися в этом месте, а затем снова запускается каждый раз, когда данные меняются. DataSnapshot переданный к обратному обращению, будет для того, что было вызвано on() . Он не будет запускать, пока все содержимое не будет синхронизировано. Если местоположение не имеет данных, оно будет инициировано пустым DataSnapshot ( val() вернуть null ).

Подпись:

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

Параметры

Параметр	Тип	Описание
запрос	Запрос	Запрос для выполнения.
перезвонить	(Снимок: DataSnapShot ) => неизвестно	Обратный вызов, который стреляет, когда происходит указанное событие. Обратный вызов будет пройти DataSnapShot.
CancelCallback	(ошибка: ошибка) => неизвестно	Необязательный обратный вызов, который будет уведомлен, если подписка на ваше событие будет отменено, потому что ваш клиент не имеет разрешения на чтение этих данных (или у нее было разрешение, но теперь потеряло их). Этот обратный вызов будет передан объекту Error , указывающий, почему произошел сбой.

Возврат:

Отписаться

Функция, которая может быть вызвана для удаления слушателя.

OnValue (запрос, обратный вызов, параметры)

Слушает изменения данных в определенном месте.

Это основной способ прочитать данные из базы данных. Ваш обратный вызов будет запускается для начальных данных и снова, когда данные будут изменяться. Вызвать возвращаемый вызов отказа от подписки, чтобы прекратить получать обновления. См. Получите данные в Интернете для получения более подробной информации.

Событие onValue будет запускать один раз с начальными данными, хранящимися в этом месте, а затем снова запускается каждый раз, когда данные меняются. DataSnapshot переданный к обратному обращению, будет для того, что было вызвано on() . Он не будет запускать, пока все содержимое не будет синхронизировано. Если местоположение не имеет данных, оно будет инициировано пустым DataSnapshot ( val() вернуть null ).

Подпись:

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

Параметры

Параметр	Тип	Описание
запрос	Запрос	Запрос для выполнения.
перезвонить	(Снимок: DataSnapShot ) => неизвестно	Обратный вызов, который стреляет, когда происходит указанное событие. Обратный вызов будет пройти DataSnapShot.
параметры	Слушайте	Объект, который можно использовать для настройки onlyOnce , который затем удаляет слушателя после первого вызова.

Возврат:

Отписаться

Функция, которая может быть вызвана для удаления слушателя.

OnValue (запрос, обратный вызов, CancelCallback, Options)

Слушает изменения данных в определенном месте.

Это основной способ прочитать данные из базы данных. Ваш обратный вызов будет запускается для начальных данных и снова, когда данные будут изменяться. Вызвать возвращаемый вызов отказа от подписки, чтобы прекратить получать обновления. См. Получите данные в Интернете для получения более подробной информации.

Событие onValue будет запускать один раз с начальными данными, хранящимися в этом месте, а затем снова запускается каждый раз, когда данные меняются. DataSnapshot переданный к обратному обращению, будет для того, что было вызвано on() . Он не будет запускать, пока все содержимое не будет синхронизировано. Если местоположение не имеет данных, оно будет инициировано пустым DataSnapshot ( val() вернуть 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 для применения.

Возврат:

Запрос

Исключения

Если какое -либо из предоставленных ограничений запроса не может быть объединено с существующими или новыми ограничениями.

функция (ref, ...)

Ondisconnect (Ref)

Возвращает объект OnDisconnect - см. Включение автономных возможностей в JavaScript для получения дополнительной информации о том, как его использовать.

Подпись:

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

Параметры

Параметр	Тип	Описание
ссылка	База данных	Ссылка на добавление триггеров Onconnect для.

Возврат:

Ondisconnect

Удалить (ссылка)

Удаляет данные в этом месте базы данных.

Любые данные в детских местах также будут удалены.

Эффект удаления будет замечен немедленно, а соответствующее значение «события» будет инициировано. 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.

Возврат:

Обещание<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.

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

Note: When using transactions with Security and Firebase Rules in place, be aware that a client needs .read access in addition to .write access in order to perform a transaction. This is because the client-side nature of transactions requires the client to read the data in order to transactionally update it.

Подпись:

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).

Возврат:

Обещание<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.
приоритет	строка | номер | нулевой	The priority to be written (string, number, or null).

Возврат:

Обещание<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).
приоритет	строка | номер | нулевой	The priority to be written (string, number, or null).

Возврат:

Обещание<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.

Возврат:

Обещание<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;

Параметры

Параметр	Тип	Описание
ценить	номер | строка | 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;

Параметры

Параметр	Тип	Описание
ценить	номер | строка | 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;

Параметры

Параметр	Тип	Описание
ценить	номер | строка | 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;

Параметры

Параметр	Тип	Описание
ценить	номер | строка | 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;

Параметры

Параметр	Тип	Описание
ценить	номер | строка | 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

EventType

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;