Class FirestoreSerializer

Class to help with serialization between Entity objects and firestore documents.

Hierarchy

FirestoreSerializer

Index

Methods

Methods

Static deserialize

deserialize<T>(doc: DocumentSnapshot, Model: object, parentCollection: ICollection<T>): T

- Defined in utils/FirestoreSerializer.ts:40
Deserializes a firestore document into an Entity.

Type parameters
- T: Entity
Parameters
- doc: DocumentSnapshot
  
  The firestore document.
- Model: object
  
  The Entity class to create an instance of.
- parentCollection: ICollection<T>
Returns T

Static serialize

serialize<T>(entity: T, writeType: WriteTypes): ISerializedResult

- Defined in utils/FirestoreSerializer.ts:21
Serializes an Entity to an object which can be inserted into firestore.

Type parameters
- T: Entity
Parameters
- entity: T
  
  Our representation of the entity.
- writeType: WriteTypes
Returns ISerializedResult

Generated using TypeDoc