Module util/documentFields

Index

Interfaces

Type aliases

Functions

Type aliases

DocumentArrayValue

DocumentArrayValue: string | number | boolean | Geopoint | DocumentData

Value within a document array

DocumentDataValue

DocumentDataValue: DocumentArrayValue | DocumentArrayValue[]

Values for fields within a document

MapFields

MapFields: Map<string, RawFirestoreDocumentField>

Fields within a Firestore-encoded map

RawFirestoreDocumentField

RawFirestoreDocumentField: RawFirestoreDocumentArrayValue | RawDocFieldArray

Values for fields within a Firestore-encoded document

Functions

decodeDocumentFieldValue

decodeDocumentFieldValue(value: RawFirestoreDocumentField): DocumentDataValue

- Defined in src/util/documentFields.ts:152
Decodes a single Firestore-encoded field value

Parameters
- value: RawFirestoreDocumentField
  
  Single Firestore-encoded field
Returns DocumentDataValue

decodeDocumentFields

decodeDocumentFields(fields: MapFields): DocumentData

- Defined in src/util/documentFields.ts:174
Decodes a Firestore-encoded map into a document map

Parameters
- fields: MapFields
  
  Map fields to decode
Returns DocumentData

encodeDocumentFieldValue

encodeDocumentFieldValue(value: DocumentDataValue): RawFirestoreDocumentField

- Defined in src/util/documentFields.ts:188
Encodes a single Document field value into

Parameters
- value: DocumentDataValue
  
  Document value to encode
Returns RawFirestoreDocumentField

encodeDocumentFields

encodeDocumentFields(fields: DocumentData): MapFields

- Defined in src/util/documentFields.ts:233
Encodes a complete document into Firestore

Parameters
- fields: DocumentData
  
  Document map to encode
Returns MapFields

Generated using TypeDoc