Class Collection<T, P>

Firestorm representation of a collection reference.

Type parameters

T: Entity

The entity for the collection documents.
P: Entity

The entity for the collection parent.

Hierarchy

Collection

Implements

ICollection<T, P>

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new Collection(E: object, parent?: IDocumentRef<P>): Collection

- Defined in Collection.ts:30
Create a collection reference from an Entity and optional parent.

Parameters
- E: object
  
  The entity class for the collections documents.
- Optional parent: IDocumentRef<P>
  
  The parent document for the collection.
Returns Collection

Accessors

native

get native(): CollectionReference

- Defined in Collection.ts:61
The native firestore collection reference.

Returns CollectionReference

parent

get parent(): IDocumentRef<P> | null

- Defined in Collection.ts:54
The parent document reference for the collection.

Returns IDocumentRef<P> | null

path

get path(): string

- Defined in Collection.ts:47
The path to this collection.

Returns string

Methods

create

create(entity: T): Promise<T | null>

- Defined in Collection.ts:142
Creates a new document from an entity instance.

Parameters
- entity: T
  
  An instance of the entity.
Returns Promise<T | null>

The created entity.

doc

doc(id: string): IDocumentRef<T>

- Defined in Collection.ts:95
Gets a document reference from the collection.

Parameters
- id: string
  
  The document ID.
Returns IDocumentRef<T>

find

find(query?: ICollectionQuery<T>): Promise<T[]>

- Defined in Collection.ts:167
Finds a list of documents based on a criteria.

deprecated

since v1.1, use query() method to build queries instead.

Parameters
- Optional query: ICollectionQuery<T>
  
  The query parameters.
Returns Promise<T[]>

A list of entities matching the criteria.

get

get(id: string): Promise<T | null>

- Defined in Collection.ts:105
Gets a document with a provided ID

Parameters
- id: string
  
  The ID of the document.
Returns Promise<T | null>

The entity.

query

query(): Query<T>

- Defined in Collection.ts:199
Entry point for building queries.

Returns Query<T>

remove

remove(id: string): Promise<void>

- Defined in Collection.ts:188
Removes a document from the collection.

Parameters
- id: string
  
  The document ID to remove.
Returns Promise<void>

update

update(entity: T): Promise<T | null>

- Defined in Collection.ts:122
Updates a document from an entity instance.

Parameters
- entity: T
  
  The entity (with ID) to update.
Returns Promise<T | null>

The updated entity.

Generated using TypeDoc