Interface IDocumentRef<T>

Type parameters

T: IEntity

Hierarchy

IDocumentRef

Implemented by

DocumentRef

Index

Properties

Methods

Properties

cached

cached: T | null

id

id: string

native

native: DocumentReference

parent

parent: ICollection<T>

path

path: string

Methods

collection

collection<C>(coll: object): ICollection<C>

- Defined in types/field.types.ts:40
Type parameters
- C: IEntity
Parameters
- coll: object
Returns ICollection<C>

get

get(): Promise<T>

- Defined in types/field.types.ts:39
Returns Promise<T>

isFetched

isFetched(): boolean

- Defined in types/field.types.ts:38
Returns boolean

onSnapshot

onSnapshot(onNext: function, onError?: undefined | function): function

- Defined in types/field.types.ts:41
Parameters
- onNext: function
  - - (snapshot: IDocumentSnapshot<T>): void
    - Parameters
      - snapshot: IDocumentSnapshot<T>
      Returns void
- Optional onError: undefined | function
Returns function
- - (): void
  - Returns void

Generated using TypeDoc