Class default

Hierarchy

default
- default

Implements

default

Constructors

constructor

new default(options, appName?): default
- Public Methods **
Parameters
- options: FirebaseOptions
- Optional appName: string
Returns default
Overrides default.constructor
- Defined in src/DGFirebase.m.ts:209

Properties

`Private` #app

#app: FirebaseApp

The Firebase app instance

Member

`Private` #appName

#appName: string

The Firebase app name. If none is provided, the default is "[DEFAULT]"

Member

`Private` #auth

#auth: Auth

The Firebase auth instance

Member

See

https://firebase.google.com/docs/reference/js/auth

`Private` #firestore

#firestore: Firestore

The Firebase Firestore instance

Member

See

https://firebase.google.com/docs/reference/js/firestore_.md#@firebase/firestore

`Private` #options

#options: FirebaseOptions

The Firebase options object

Member

See

https://firebase.google.com/docs/reference

`Private` #storage

#storage: FirebaseStorage

The Firebase storage instance

Member

See

https://firebase.google.com/docs/reference/js/storage_.md#@firebase/storage

Methods

`Private` #initializeApp

#initializeApp(app): void
Parameters
- app: FirebaseApp
  
  A Firebase app instance
Returns void
- Defined in src/DGFirebase.m.ts:144

`Private` #initializeAuth

#initializeAuth(auth): void
Parameters
- auth: Auth
  
  A Firebase auth instance
Returns void
- Defined in src/DGFirebase.m.ts:151

`Private` #initializeDocument

#initializeDocument(collectionName, documentName): Promise<InitializedDocument>
Initialize the document to obtain the data.
Parameters
- collectionName: string
  
  The name of the collection to initialize the document
- documentName: string
  
  The name of the document to be initialized
Returns Promise<InitializedDocument>
- The document and reference objects
- Defined in src/DGFirebase.m.ts:162

`Private` #initializeFirestore

#initializeFirestore(firestore): void
Parameters
- firestore: Firestore
  
  A Firebase firestore instance
Returns void
- Defined in src/DGFirebase.m.ts:185

`Private` #initializeStorage

#initializeStorage(storage): void
Parameters
- storage: FirebaseStorage
Returns void
- Defined in src/DGFirebase.m.ts:192

`Protected` _init

_init(): void
- Protected Methods **
Returns void
Overrides default._init
- Defined in src/DGFirebase.m.ts:198

anonymousSignIn

anonymousSignIn(): Promise<UserCredential>
Sign the user in anonymously.

Returns Promise<UserCredential>
The anonymous user's credentials
- Defined in src/DGFirebase.m.ts:222

create

create(collectionName, documentName, documentData): Promise<DocumentReference<DocumentData>>
Creates a document with a data object.
Parameters
- collectionName: string
  
  The name of the collection to create the doc in
- documentName: string
  
  The name of the document to create
- documentData: object
  
  The data to create the document with
Returns Promise<DocumentReference<DocumentData>>
A reference to the document on success
Implementation of default.create
- Defined in src/DGFirebase.m.ts:234

createID

createID(): string | number[]
Generate a random string of characters to be used as a unique id

Returns string | number[]
- The result of the call to the uuid function
Inherited from default.createID
- Defined in src/DGElement.m.ts:36

deg2rad

deg2rad(d): number
Convert an angle in degrees to radians
Parameters
- d: number
  
  the angle in degrees
Returns number
the angle in radians
Inherited from default.deg2rad
- Defined in src/DGElement.m.ts:46

deleteAccount

deleteAccount(userUpdate, deleteDocuments): Promise<string>
Delete the user's account and notifies on success or failure.
Parameters
- userUpdate: UserUpdate
  
  The user update object with new details
- deleteDocuments: (() => Promise<void>)
  
  A function that deletes user-associated data
  - - (): Promise<void>
    - Returns Promise<void>
Returns Promise<string>
An empty string on success, else an error message
- Defined in src/DGFirebase.m.ts:263

deleteEntry

deleteEntry(collectionName, documentName, field): Promise<boolean>
Deletes a field from a given document.
Parameters
- collectionName: string
  
  The name of the collection to delete from
- documentName: string
  
  The name of the document to delete from
- field: string
  
  The field to delete
Returns Promise<boolean>
True on success, else false
Implementation of default.deleteEntry
- Defined in src/DGFirebase.m.ts:302

deleteGroup

deleteGroup(collectionName, documentName): Promise<boolean>
Deletes an entire document from the firestore.
Parameters
- collectionName: string
  
  The name of the collection to delete from
- documentName: string
  
  The name of the document to delete
Returns Promise<boolean>
True on success, else false
Implementation of default.deleteGroup
- Defined in src/DGFirebase.m.ts:332

deleteImage

deleteImage(imagePath): Promise<boolean>
Delete an image from the storage bucket.
Parameters
- imagePath: string
  
  The path of the image to be deleted
Returns Promise<boolean>
true if delete was successful, else false
- Defined in src/DGFirebase.m.ts:358

distance

distance(p1, p2): number
Calculate the linear distance between two points using the Haversine formula

Todo
Limit the coordinates to the min/max ranges

See
Point
Parameters
- p1: Point
  
  Point one
- p2: Point
  
  Point two
Returns number
The distance in km
Inherited from default.distance
- Defined in src/DGElement.m.ts:59

getAllDocuments

getAllDocuments(collectionName): Promise<QueryDocumentSnapshot<DocumentData>[]>
Retreive all documents for a collection. Requires read permission for all documents.
Parameters
- collectionName: string
  
  The name of the collection to get docs from
Returns Promise<QueryDocumentSnapshot<DocumentData>[]>
- An array of documents
- Defined in src/DGFirebase.m.ts:380

getApp

getApp(): FirebaseApp
Returns FirebaseApp
The initialized Firebase app
- Defined in src/DGFirebase.m.ts:395

getAuth

getAuth(): Auth
Returns Auth
The initialized Firebase Auth instance
- Defined in src/DGFirebase.m.ts:402

getFirestore

getFirestore(): Firestore
Returns Firestore
The initialized Firestore instance
- Defined in src/DGFirebase.m.ts:409

getStorage

getStorage(): FirebaseStorage
Returns FirebaseStorage
The initialized Firestore storage
- Defined in src/DGFirebase.m.ts:416

handlePasswordReset

handlePasswordReset(email): Promise<boolean>
Reset the user password.
Parameters
- email: string
  
  The user's email address
Returns Promise<boolean>
True on success, else false
- Defined in src/DGFirebase.m.ts:426

read

read(collectionName, documentName): Promise<DocumentData>
Read a document from the given collection.
Parameters
- collectionName: string
  
  The name of the collection containing the document
- documentName: string
  
  The name of the document being updated
Returns Promise<DocumentData>
The data from the retrieved document
Implementation of default.read
- Defined in src/DGFirebase.m.ts:445

search

search(collectionName, field, needle, comparison, caseSensitive?): Promise<false | SearchResult[]>
Search a given collection field for a value.
Parameters
- collectionName: string
  
  The name of the collection to search
- field: string
  
  The name of the field to search
- needle: string
  
  The value to search for
- comparison: WhereFilterOp
  
  A string describing the comparison operator
- caseSensitive: boolean = false
  
  True for a case-sensitive search (default false)
Returns Promise<false | SearchResult[]>
An array of search results or false on failure
Implementation of default.search
- Defined in src/DGFirebase.m.ts:463

signInWithEmail

signInWithEmail(email, password): Promise<string>
Sign in to Firebase using email and password.
Parameters
- email: string
  
  The user's email address
- password: string
  
  The user's password
Returns Promise<string>
A sign in error message or an empty string on success
- Defined in src/DGFirebase.m.ts:550

signOutUser

signOutUser(): void
Sign out the current user

Returns void
- Defined in src/DGFirebase.m.ts:565

signUpWithEmail

signUpWithEmail(userUpdate): Promise<string>
Sign up a new user. Create a new user document and update the user profile in firestore. Requires write permission for the User collection.
Parameters
- userUpdate: UserUpdate
  
  The user update object set with new data
Returns Promise<string>
A sign up error message or an empty string on success
- Defined in src/DGFirebase.m.ts:501

update

update(collectionName, documentName, updateData): Promise<boolean>
Updates a document in the given collection. Creates the document if it does not exist.
Parameters
- collectionName: string
  
  The name of the collection to update
- documentName: string
  
  The name of the document to update
- updateData: object
  
  The updated document data
Returns Promise<boolean>
True on success, else false
Implementation of default.update
- Defined in src/DGFirebase.m.ts:577

updateUserAccount

updateUserAccount(userUpdate): Promise<string>
Updates the user's account details and notifies the caller on success or error. Requires write permission for the User collection in firestore.
Parameters
- userUpdate: UserUpdate
  
  The updated user information
Returns Promise<string>
An empty string on success, else an error message
- Defined in src/DGFirebase.m.ts:615

uploadImage

uploadImage(imageFileURL, onUploadComplete, setProgress?, handleError?, detailedProgress?, unsubscribe?): Promise<void>
Upload an image to the firebase storage bucket.
Parameters
- imageFileURL: string
  
  the url of the local image to be uploaded
- onUploadComplete: ((__namedParameters) => void)
  
  callback to set the download url
  - - (__namedParameters): void
    - Parameters
      
      __namedParameters: Object
      
      Returns void
- setProgress: ((progress) => void) = ...
  
  callback to update the progress bar
  - - (progress): void
    - Parameters
      
      progress: number
      
      Returns void
- handleError: ((error) => void) = console.error
  
  callback to handle errors
  - - (error): void
    - Parameters
      
      error: any
      
      Returns void
- detailedProgress: boolean = false
  
  use uploadBytesResumable to track detailed progress
- unsubscribe: Unsubscribe = ...
  
  unsubscribe from the upload task (detailed progress only)
Returns Promise<void>
- Defined in src/DGFirebase.m.ts:695

Class default

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: FirebaseOptions

Optional appName: string

Returns default

Properties

Private #app

Member

Private #appName

Member

Private #auth

Member

See

Private #firestore

Member

See

Private #options

Member

See

Private #storage

Member

See

Methods

Private #initializeApp

Parameters

app: FirebaseApp

Returns void

Private #initializeAuth

Parameters

auth: Auth

Returns void

Private #initializeDocument

Parameters

collectionName: string

documentName: string

Returns Promise<InitializedDocument>

Private #initializeFirestore

Parameters

firestore: Firestore

Returns void

Private #initializeStorage

Parameters

storage: FirebaseStorage

Returns void

Protected _init

Returns void

anonymousSignIn

Returns Promise<UserCredential>

create

Parameters

collectionName: string

documentName: string

documentData: object

Returns Promise<DocumentReference<DocumentData>>

createID

Returns string | number[]

deg2rad

Parameters

d: number

Returns number

deleteAccount

Parameters

userUpdate: UserUpdate

deleteDocuments: (() => Promise<void>)

Returns Promise<void>

Returns Promise<string>

deleteEntry

Parameters

collectionName: string

documentName: string

field: string

Returns Promise<boolean>

`Optional` appName: string

`Private` #app

`Private` #appName

`Private` #auth

`Private` #firestore

`Private` #options

`Private` #storage

`Private` #initializeApp

`Private` #initializeAuth

`Private` #initializeDocument

`Private` #initializeFirestore

`Private` #initializeStorage

`Protected` _init