Class CollectionListenerEvent<T_model>

Events emitted after a collection is modified.

Type Parameters

T_model extends IFirestormModel

Hierarchy (View Summary)

CollectionListenerEvent
- QueryListenerEvent

Index

Accessors

count docChanges documents empty isInitial models source

Accessors

count

get count(): number
The number of documents after the change

Returns number
- Defined in packages/firestorm/src/realtime-listener/collection-observable.ts:91

docChanges

get docChanges(): DocumentChange<T_model>[]
All the changes, document by document

Returns DocumentChange<T_model>[]
- Defined in packages/firestorm/src/realtime-listener/collection-observable.ts:42

documents

get documents(): DocumentData[]
All the firestore documents

Returns DocumentData[]
- Defined in packages/firestorm/src/realtime-listener/collection-observable.ts:28

empty

get empty(): boolean
True if the collection is empty

Returns boolean
- Defined in packages/firestorm/src/realtime-listener/collection-observable.ts:84

isInitial

get isInitial(): boolean
True if it's the first event emitted by the listener

Returns boolean
- Defined in packages/firestorm/src/realtime-listener/collection-observable.ts:105

models

get models(): T_model[]
All the models

Returns T_model[]
- Defined in packages/firestorm/src/realtime-listener/collection-observable.ts:35

source

get source(): "server" | "local"
Source of the document change

Returns "server" | "local"
- Defined in packages/firestorm/src/realtime-listener/collection-observable.ts:98