Class DataService

DataService class used for initialize the SDK

Hierarchy

DataService

Index

Constructors

Properties

appRef collectionName? collectionRef? db

Methods

collection find findById removeAll removeById save saveById subCollection update

Constructors

constructor

new DataService(app?: FirebaseApp): DataService
Creates an instance of DataService.

Memberof
DataService
Parameters
- Optional app: FirebaseApp
  
  instance of firebase app
Returns DataService
- Defined in src/lib/data-service/data.service.ts:37

Properties

appRef

appRef: FirebaseApp

`Optional` collectionName

collectionName?: string

`Optional` collectionRef

collectionRef?: CollectionReference<DocumentData, DocumentData>

db

db: Firestore

Methods

collection

collection(collectionName: string): DataService
This method used to keep the instance of the collection.
Parameters
- collectionName: string
  
  string
Returns DataService
- Defined in src/lib/data-service/data.service.ts:58

find

find(queryConstraints?: QueryConstraint[]): Promise<QuerySnapshot<DocumentData, DocumentData>>
This method used to returns the DocumentData stored in the firestores's collection.

Returns
Promise<QuerySnapshot>
Parameters
- Optional queryConstraints: QueryConstraint[]
  
  array ( list of where clauses )
Returns Promise<QuerySnapshot<DocumentData, DocumentData>>
- Defined in src/lib/data-service/data.service.ts:81

findById

findById(docId: string): Promise<DocumentSnapshot<DocumentData, DocumentData>>
Parameters
- docId: string
Returns Promise<DocumentSnapshot<DocumentData, DocumentData>>
- Defined in src/lib/data-service/data.service.ts:97

removeAll

removeAll(): Promise<any>
This method used to delete all the document from the firebase collection.

Returns
Promise

Returns Promise<any>
- Defined in src/lib/data-service/data.service.ts:176

removeById

removeById(docId: string): Promise<void>
This method used to delete the document from the firebase collection.

Returns
Promise
Parameters
- docId: string
  
  string
Returns Promise<void>
- Defined in src/lib/data-service/data.service.ts:162

save

save(docData: {}): Promise<DocumentReference<DocumentData, DocumentData>>
This method used to add the document to the firebase collection.

Returns
Promise
Parameters
- docData: {}
  
  object
Returns Promise<DocumentReference<DocumentData, DocumentData>>
- Defined in src/lib/data-service/data.service.ts:113

saveById

saveById(docId: string, docData: {}): Promise<void>
This method used to add the document to the firebase collection with a sepcific ID.

Returns
Promise
Parameters
- docId: string
  
  string
- docData: {}
  
  object
Returns Promise<void>
- Defined in src/lib/data-service/data.service.ts:137

subCollection

subCollection(parentDocId: string, subCollectionName: string): DataService
This method used to keep the instance of the sub collection.
Parameters
- parentDocId: string
- subCollectionName: string
  
  string
Returns DataService
- Defined in src/lib/data-service/data.service.ts:69

update

update(docId: string, data: {}): Promise<any>
This method used to update/change the document data in the firebase collection.

Returns
Promise
Parameters
- docId: string
  
  string
- data: {}
  
  object
Returns Promise<any>
- Defined in src/lib/data-service/data.service.ts:198

Generated using TypeDoc