FirebaseDatabaseRef | firebase-rxjs

Type parameters

T

Hierarchy

FirebaseQuery<T>
- FirebaseDatabaseRef

Index

Constructors

constructor

Properties

Accessors

key
ref

Constructors

constructor

new FirebaseDatabaseRef(parent: FirebaseDatabaseRef<any> | null, ref: NativeDatabaseRef, app: FirebaseApp): FirebaseDatabaseRef

Overrides FirebaseQuery.constructor
- Defined in src/database.ts:205
Parameters
- parent: FirebaseDatabaseRef<any> | null
- ref: NativeDatabaseRef
- app: FirebaseApp
Returns FirebaseDatabaseRef

Properties

_ref

_ref: NativeDatabaseRef

app

app: FirebaseApp

parent

parent: FirebaseDatabaseRef<any> | null

wrappedRef

wrappedRef: FirebaseDatabaseRef<T>

Accessors

key

key:

ref

ref:

Methods

child

child<P>(path: P): FirebaseDatabaseRef<T[P]>

- Defined in src/database.ts:215
Type parameters
- P: keyof T
Parameters
- path: P
Returns FirebaseDatabaseRef<T[P]>

endAt

endAt(value: number | string | boolean | null, key?: keyof T[keyof T]): FirebaseQuery<T>

Inherited from FirebaseQuery.endAt
- Defined in src/database.ts:75
Parameters
- value: number | string | boolean | null
- Optional key: keyof T[keyof T]
Returns FirebaseQuery<T>

equalTo

equalTo(value: number | string | boolean | null, key?: keyof T[keyof T]): FirebaseQuery<T>

Inherited from FirebaseQuery.equalTo
- Defined in src/database.ts:80
Parameters
- value: number | string | boolean | null
- Optional key: keyof T[keyof T]
Returns FirebaseQuery<T>

isEqual

isEqual(query: FirebaseQuery<any>): boolean

Inherited from FirebaseQuery.isEqual
- Defined in src/database.ts:153
Parameters
- query: FirebaseQuery<any>
Returns boolean

limitToFirst

limitToFirst(limit: number): FirebaseQuery<T>

Inherited from FirebaseQuery.limitToFirst
- Defined in src/database.ts:85
Parameters
- limit: number
Returns FirebaseQuery<T>

limitToLast

limitToLast(limit: number): FirebaseQuery<T>

Inherited from FirebaseQuery.limitToLast
- Defined in src/database.ts:90
Parameters
- limit: number
Returns FirebaseQuery<T>

on

on(event: "value"): DataSnapshotObservable<T>
on(event: "child_added"): DataSnapshotObservable<T[keyof T]>
on(event: "child_changed"): DataSnapshotObservable<T[keyof T]>
on(event: "child_moved"): DataSnapshotObservable<T[keyof T]>
on(event: "child_removed"): DataSnapshotObservable<T[keyof T]>

Inherited from FirebaseQuery.on
- Defined in src/database.ts:124
Parameters
- event: "value"
Returns DataSnapshotObservable<T>
Inherited from FirebaseQuery.on
- Defined in src/database.ts:125
Parameters
- event: "child_added"
Returns DataSnapshotObservable<T[keyof T]>
Inherited from FirebaseQuery.on
- Defined in src/database.ts:126
Parameters
- event: "child_changed"
Returns DataSnapshotObservable<T[keyof T]>
Inherited from FirebaseQuery.on
- Defined in src/database.ts:127
Parameters
- event: "child_moved"
Returns DataSnapshotObservable<T[keyof T]>
Inherited from FirebaseQuery.on
- Defined in src/database.ts:128
Parameters
- event: "child_removed"
Returns DataSnapshotObservable<T[keyof T]>

onChildAdded

onChildAdded(): DataSnapshotObservable<T[keyof T]>

Inherited from FirebaseQuery.onChildAdded
- Defined in src/database.ts:137
Returns DataSnapshotObservable<T[keyof T]>

onChildChanged

onChildChanged(): DataSnapshotObservable<T[keyof T]>

Inherited from FirebaseQuery.onChildChanged
- Defined in src/database.ts:141
Returns DataSnapshotObservable<T[keyof T]>

onChildMoved

onChildMoved(): DataSnapshotObservable<T[keyof T]>

Inherited from FirebaseQuery.onChildMoved
- Defined in src/database.ts:145
Returns DataSnapshotObservable<T[keyof T]>

onChildRemoved

onChildRemoved(): DataSnapshotObservable<T[keyof T]>

Inherited from FirebaseQuery.onChildRemoved
- Defined in src/database.ts:149
Returns DataSnapshotObservable<T[keyof T]>

onValue

onValue(): DataSnapshotObservable<T>

Inherited from FirebaseQuery.onValue
- Defined in src/database.ts:133
Returns DataSnapshotObservable<T>

once

once(event: "value"): DataSnapshotObservable<T>
once(event: "child_added"): DataSnapshotObservable<T[keyof T]>
once(event: "child_changed"): DataSnapshotObservable<T[keyof T]>
once(event: "child_moved"): DataSnapshotObservable<T[keyof T]>
once(event: "child_removed"): DataSnapshotObservable<T[keyof T]>

Inherited from FirebaseQuery.once
- Defined in src/database.ts:95
Parameters
- event: "value"
Returns DataSnapshotObservable<T>
Inherited from FirebaseQuery.once
- Defined in src/database.ts:96
Parameters
- event: "child_added"
Returns DataSnapshotObservable<T[keyof T]>
Inherited from FirebaseQuery.once
- Defined in src/database.ts:97
Parameters
- event: "child_changed"
Returns DataSnapshotObservable<T[keyof T]>
Inherited from FirebaseQuery.once
- Defined in src/database.ts:98
Parameters
- event: "child_moved"
Returns DataSnapshotObservable<T[keyof T]>
Inherited from FirebaseQuery.once
- Defined in src/database.ts:99
Parameters
- event: "child_removed"
Returns DataSnapshotObservable<T[keyof T]>

onceChildAdded

onceChildAdded(): DataSnapshotObservable<T[keyof T]>

Inherited from FirebaseQuery.onceChildAdded
- Defined in src/database.ts:108
Returns DataSnapshotObservable<T[keyof T]>

onceChildChanged

onceChildChanged(): DataSnapshotObservable<T[keyof T]>

Inherited from FirebaseQuery.onceChildChanged
- Defined in src/database.ts:112
Returns DataSnapshotObservable<T[keyof T]>

onceChildMoved

onceChildMoved(): DataSnapshotObservable<T[keyof T]>

Inherited from FirebaseQuery.onceChildMoved
- Defined in src/database.ts:116
Returns DataSnapshotObservable<T[keyof T]>

onceChildRemoved

onceChildRemoved(): DataSnapshotObservable<T[keyof T]>

Inherited from FirebaseQuery.onceChildRemoved
- Defined in src/database.ts:120
Returns DataSnapshotObservable<T[keyof T]>

onceValue

onceValue(): DataSnapshotObservable<T>

Inherited from FirebaseQuery.onceValue
- Defined in src/database.ts:104
Returns DataSnapshotObservable<T>

orderByChild

orderByChild(child: keyof T[keyof T]): FirebaseQuery<T>

Inherited from FirebaseQuery.orderByChild
- Defined in src/database.ts:50
Parameters
- child: keyof T[keyof T]
Returns FirebaseQuery<T>

orderByKey

orderByKey(): FirebaseQuery<T>

Inherited from FirebaseQuery.orderByKey
- Defined in src/database.ts:55
Returns FirebaseQuery<T>

orderByPriority

orderByPriority(): FirebaseQuery<T>

Inherited from FirebaseQuery.orderByPriority
- Defined in src/database.ts:60
Returns FirebaseQuery<T>

orderByValue

orderByValue(): FirebaseQuery<T>

Inherited from FirebaseQuery.orderByValue
- Defined in src/database.ts:65
Returns FirebaseQuery<T>

push

push<P>(value?: P): Observable<FirebaseDatabaseRef<P>>

- Defined in src/database.ts:234
Type parameters
- P: T[keyof T]
Parameters
- Optional value: P
Returns Observable<FirebaseDatabaseRef<P>>

remove

remove(): Observable<void>

- Defined in src/database.ts:250
Returns Observable<void>

set

set(value: T): Observable<void>

- Defined in src/database.ts:219
Parameters
- value: T
Returns Observable<void>

setPriority

setPriority(priority: string | number | null): Observable<void>

- Defined in src/database.ts:223
Parameters
- priority: string | number | null
Returns Observable<void>

setWithPriority

setWithPriority(newVal: T, priority: string | number | null): Observable<void>

- Defined in src/database.ts:230
Parameters
- newVal: T
- priority: string | number | null
Returns Observable<void>

startAt

startAt(value: number | string | boolean | null, key?: keyof T[keyof T]): FirebaseQuery<T>

Inherited from FirebaseQuery.startAt
- Defined in src/database.ts:70
Parameters
- value: number | string | boolean | null
- Optional key: keyof T[keyof T]
Returns FirebaseQuery<T>

transaction

transaction(transactionHandler: function, applyLocally?: boolean): Observable<object>

- Defined in src/database.ts:254
Parameters
- transactionHandler: function
  - - (node: T | null): T | null | never
    - Parameters
      - node: T | null
      Returns T | null | never
- Optional applyLocally: boolean
Returns Observable<object>

update

update(value: T): Observable<void>

- Defined in src/database.ts:246
Parameters
- value: T
Returns Observable<void>

Generated using TypeDoc