Class MFDao<M>

inheritdoc

Type parameters

M: MFModel<M>

Hierarchy

MFDao
- SubMFDao
- MFFlattableDao

Implements

IMFDao<M>

Index

Constructors

constructor

Properties

Constructors

constructor

new MFDao(db: Firestore, storage?: Bucket): MFDao

- Defined in src/mf-dao.ts:35
Must be called with super()

Parameters
- db: Firestore
  
  The databse to use to store data
- Optional storage: Bucket
  
  The bucket where files will be stored
Returns MFDao

Properties

Protected db

db: Firestore

The databse to use to store data

mustachePath

mustachePath: string = Reflect.getMetadata('mustachePath', this.constructor)

Collection path with mustache document ids (e.g. lists/{lists}/items)

Protected Optional storage

storage: Bucket

The bucket where files will be stored

Methods

beforeSave

beforeSave(model: Partial<M>, idOrLocation?: string | Partial<IMFLocation>): Promise<Partial<M>>

Implementation of IMFDao.beforeSave
- Defined in src/mf-dao.ts:331
Override this method to execute actions before saving document in database

Parameters
- model: Partial<M>
  
  the document to save
- Optional idOrLocation: string | Partial<IMFLocation>
  
  id or location (pathIds) where the document will be saved
Returns Promise<Partial<M>>

Promise with the document that will be saved instead of the input one

create

create(data: M, idOrLocation?: string | Partial<IMFLocation>, options?: IMFSaveOptions): Promise<M>

- Defined in src/mf-dao.ts:183
inheritdoc

Parameters
- data: M
- Optional idOrLocation: string | Partial<IMFLocation>
- Optional options: IMFSaveOptions
Returns Promise<M>

delete

delete(idLocationOrModel: string | IMFLocation | M, options?: IMFDeleteOptions<M>): Promise<void>

- Defined in src/mf-dao.ts:261
inheritdoc

Parameters
- idLocationOrModel: string | IMFLocation | M
- Optional options: IMFDeleteOptions<M>
Returns Promise<void>

deleteByReference

deleteByReference(reference: DocumentReference): Promise<void>

- Defined in src/mf-dao.ts:283
Delete a model by its reference

Parameters
- reference: DocumentReference
  
  Document reference
Returns Promise<void>

deleteFile

deleteFile(fileObject: IMFFile): Promise<void>

Implementation of IMFDao.deleteFile
- Defined in src/mf-dao.ts:392
Override this method to delete files from somewhere else than in firestore storage

Parameters
- fileObject: IMFFile
  
  File object containing the file to delete
Returns Promise<void>

Private deleteFiles

deleteFiles(model: M, options?: IMFDeleteOnDeleteFilesOptions<M>): Promise<M>

- Defined in src/mf-dao.ts:366
Delete files from declared file properties and returns the model

Parameters
- model: M
  
  the model for which files must be deleted
- Optional options: IMFDeleteOnDeleteFilesOptions<M>
  
  override delete on delete default option
Returns Promise<M>

Promise of the model

get

get(idOrLocation: string | IMFLocation, options?: IMFGetOneOptions): Promise<M>

Implementation of IMFDao.get
- Defined in src/mf-dao.ts:68
Get a model from database from id or location

Parameters
- idOrLocation: string | IMFLocation
  
  id or location of the document in database
- Optional options: IMFGetOneOptions
  
  (withSnapshot, completeOnFirst, cacheable)
Returns Promise<M>

asynchronous answer with model

getByPath

getByPath(path: string, options?: IMFGetOneOptions): Promise<M>

Implementation of IMFDao.getByPath
- Defined in src/mf-dao.ts:102
Get a model from database from its path

Parameters
- path: string
  
  String path to the document in database
- Optional options: IMFGetOneOptions
  
  (withSnapshot, completeOnFirst, cacheable)
Returns Promise<M>

asynchronous answer with model

getByReference

getByReference(reference: DocumentReference, options?: IMFGetOneOptions): Promise<M>

Implementation of IMFDao.getByReference
- Defined in src/mf-dao.ts:83
Get a model from database from its reference

Parameters
- reference: DocumentReference
  
  Document reference
- Optional options: IMFGetOneOptions
  
  (withSnapshot, completeOnFirst, cacheable)
Returns Promise<M>

asynchronous answer with model

Private getFileProperties

getFileProperties(model?: Partial<M>): string[]

- Defined in src/mf-dao.ts:482
Returns array of file properties names for the partial model consumed or if missing, for the model appliable to this dao

Parameters
- Optional model: Partial<M>
  
  Some partial or full model
Returns string[]

getList

getList(location?: Omit<IMFLocation, "id">, options?: IMFGetListOptions<M>): Promise<M[]>

Implementation of IMFDao.getList
- Defined in src/mf-dao.ts:129
Get a list of documents in the collection

Parameters
- Optional location: Omit<IMFLocation, "id">
  
  List of path ids
- Optional options: IMFGetListOptions<M>
  
  (withSnapshot, completeOnFirst, where, orderBy, limit, offset, cacheable)
Returns Promise<M[]>

getModelFromSnapshot

getModelFromSnapshot(snapshot: DocumentSnapshot): M

Implementation of IMFDao.getModelFromSnapshot
- Defined in src/mf-dao.ts:296
Convert a database document snapshot to a model

Parameters
- snapshot: DocumentSnapshot
  
  Database document snapshot
Returns M

Model

Abstract getNewModel

getNewModel(data?: Partial<M>, location?: Partial<IMFLocation>): M

Implementation of IMFDao.getNewModel
- Defined in src/mf-dao.ts:60
Get a new instance of model M

Parameters
- Optional data: Partial<M>
  
  Data to inject in this model
- Optional location: Partial<IMFLocation>
  
  Location of the model in database
Returns M

new model

Private getOffsetSnapshot

getOffsetSnapshot(offsetOption: IMFOffset<M>, options?: IMFGetOneOptions): Promise<DocumentSnapshot>

- Defined in src/mf-dao.ts:452
Get the first offset snapshot available (startAt > startAfter > endAt > endBefore)

Parameters
- offsetOption: IMFOffset<M>
  
  The offset option value used here
- Optional options: IMFGetOneOptions
  
  get one options to apply
Returns Promise<DocumentSnapshot>

getReference

getReference(idOrLocation: string | Partial<IMFLocation>): DocumentReference | CollectionReference

- Defined in src/mf-dao.ts:115
inheritdoc

Parameters
- idOrLocation: string | Partial<IMFLocation>
Returns DocumentReference | CollectionReference

getReferenceFromPath

getReferenceFromPath(path: string): DocumentReference | CollectionReference

- Defined in src/mf-dao.ts:463
Get a reference from a compatible path

Parameters
- path: string
  
  The path for which get a reference
Returns DocumentReference | CollectionReference

a CollectionReference or a documentReference depending on the path param

getSnapshot

getSnapshot(idOrLocation: string | IMFLocation, options?: IMFGetOneOptions): Promise<DocumentSnapshot>

Implementation of IMFDao.getSnapshot
- Defined in src/mf-dao.ts:320
Get a document snapshot from database from an id or a location

Parameters
- idOrLocation: string | IMFLocation
  
  id or location (pathIds)
- Optional options: IMFGetOneOptions
  
  (where, orderBy, limit, offset, cacheable)
Returns Promise<DocumentSnapshot>

Async answer with the snapshot

isCompatible

isCompatible(modelOrReference: M | DocumentReference | CollectionReference): boolean

- Defined in src/mf-dao.ts:409
Check if the model or reference is compatible with this DAO based on its path

Parameters
- modelOrReference: M | DocumentReference | CollectionReference
  
  Model or reference to chheck
Returns boolean

saveFile

saveFile(fileObject: IMFFile, location: string | IMFLocation): Promise<IMFFile>

Implementation of IMFDao.saveFile
- Defined in src/mf-dao.ts:355
Override this method to save files somewhere else than in firestore storage

Parameters
- fileObject: IMFFile
  
  File object containing the file to save
- location: string | IMFLocation
  
  id or location (pathIds) of the document containing the file object
Returns Promise<IMFFile>

Promise of the file object containing storage informations

Private saveFiles

saveFiles(model: Partial<M>, location: IMFLocation): Promise<object>

- Defined in src/mf-dao.ts:342
Save files from declared file properties and returns the model with storage informations and location with new document id

Parameters
- model: Partial<M>
  
  the model for which files must be stored
- location: IMFLocation
  
  location of the model
Returns Promise<object>

Promise of an object containing the model with storage informations and location with new document id

update

update(data: Partial<M>, idOrLocationOrModel?: string | IMFLocation | M, options?: IMFUpdateOptions<M>): Promise<Partial<M>>

- Defined in src/mf-dao.ts:240
inheritdoc

Parameters
- data: Partial<M>
- Optional idOrLocationOrModel: string | IMFLocation | M
- Optional options: IMFUpdateOptions<M>
Returns Promise<Partial<M>>

Private warnOnUnusedOptions

warnOnUnusedOptions(methodName: string): (Anonymous function)

- Defined in src/mf-dao.ts:429
Returns a function consuming an options object and displaying a warning if some options are not available in nodejs context

Parameters
- methodName: string
  
  The name of the method where this method was called
Returns (Anonymous function)

Generated using TypeDoc