UNPKG

1.13 kBTypeScriptView Raw
1import { QueryChange } from 'rxfire/database';
2import { ReactFireOptions, ObservableStatus } from './';
3import type { Query as DatabaseQuery, DatabaseReference } from 'firebase/database';
4/**
5 * Subscribe to a Realtime Database object
6 *
7 * @param ref - Reference to the DB object you want to listen to
8 * @param options
9 */
10export declare function useDatabaseObject<T = unknown>(ref: DatabaseReference, options?: ReactFireOptions<T>): ObservableStatus<QueryChange | T>;
11export declare function useDatabaseObjectData<T>(ref: DatabaseReference, options?: ReactFireOptions<T>): ObservableStatus<T>;
12/**
13 * Subscribe to a Realtime Database list
14 *
15 * @param ref - Reference to the DB List you want to listen to
16 * @param options
17 */
18export declare function useDatabaseList<T = {
19 [key: string]: unknown;
20}>(ref: DatabaseReference | DatabaseQuery, options?: ReactFireOptions<T[]>): ObservableStatus<QueryChange[] | T[]>;
21export declare function useDatabaseListData<T = {
22 [key: string]: unknown;
23}>(ref: DatabaseReference | DatabaseQuery, options?: ReactFireOptions<T[]>): ObservableStatus<T[] | null>;