_database_.md

reactfire

Globals / "database"

Module: "database"

Index

Variables

• cachedQueries

Functions

• changeToData
• getUniqueIdForDatabaseQuery
• objectVal
• useDatabaseList
• useDatabaseListData
• useDatabaseObject
• useDatabaseObjectData

Variables

cachedQueries

• Const cachedQueries: Array<Query> = ((globalThis as any) as ReactFireGlobals)._reactFireDatabaseCachedQueries || []

Defined in src/database.tsx:9

Functions

changeToData

▸ changeToData(change: QueryChange, keyField?: undefined | string): object

Defined in src/database.tsx:44

Parameters:

Name	Type
change	QueryChange
keyField?	undefined | string

Returns: object

---

getUniqueIdForDatabaseQuery

▸ getUniqueIdForDatabaseQuery(query: Query): number

Defined in src/database.tsx:15

Parameters:

Name	Type
query	Query

Returns: number

---

objectVal

▸ objectVal<T>(query: Query, keyField?: undefined | string): Observable<T>

Defined in src/database.tsx:40

Type parameters:

Name
T

Parameters:

Name	Type
query	Query
keyField?	undefined | string

Returns: Observable<T>

---

useDatabaseList

▸ useDatabaseList<T>(ref: Reference | Query, options?: ReactFireOptions<T[]>): ObservableStatus<QueryChange[] | T[]>

Defined in src/database.tsx:73

Subscribe to a Realtime Database list

Type parameters:

Name	Default
T	{ [key:string]: unknown; }

Parameters:

Name	Type	Description
ref	Reference | Query	Reference to the DB List you want to listen to
options?	ReactFireOptions<T[]>

Returns: ObservableStatus<QueryChange[] | T[]>

---

useDatabaseListData

▸ useDatabaseListData<T>(ref: Reference | Query, options?: ReactFireOptions<T[]>): ObservableStatus<T[]>

Defined in src/database.tsx:83

Type parameters:

Name	Default
T	{ [key:string]: unknown; }

Parameters:

Name	Type
ref	Reference | Query
options?	ReactFireOptions<T[]>

Returns: ObservableStatus<T[]>

---

useDatabaseObject

▸ useDatabaseObject<T>(ref: Reference, options?: ReactFireOptions<T>): ObservableStatus<QueryChange | T>

Defined in src/database.tsx:29

Subscribe to a Realtime Database object

Type parameters:

Name	Default
T	unknown

Parameters:

Name	Type	Description
ref	Reference	Reference to the DB object you want to listen to
options?	ReactFireOptions<T>

Returns: ObservableStatus<QueryChange | T>

---

useDatabaseObjectData

▸ useDatabaseObjectData<T>(ref: Reference, options?: ReactFireOptions<T>): ObservableStatus<T>

Defined in src/database.tsx:59

Type parameters:

Name
T

Parameters:

Name	Type
ref	Reference
options?	ReactFireOptions<T>

Returns: ObservableStatus<T>