From a041bbb03a9ca6af9c3bbdf25d18d2447214bbf7 Mon Sep 17 00:00:00 2001 From: Siarhei Date: Thu, 14 Mar 2024 01:43:42 +0000 Subject: [PATCH] 'hosting' --- .../FirebaseEngine.FirebaseEngine.html | 16 +++++----- docs/classes/jobs_Jobs.Jobs.html | 18 +++++------ .../jobs_backup_auth.JobBackupAuth.html | 28 ++++++++-------- ...s_backup_firestore.JobBackupFirestore.html | 30 ++++++++--------- .../jobs_backup_storage.JobBackupStorage.html | 26 +++++++-------- .../classes/jobs_clean_auth.JobCleanAuth.html | 24 +++++++------- ...obs_clean_firestore.JobCleanFirestore.html | 30 ++++++++--------- .../jobs_clean_storage.JobCleanStorage.html | 20 ++++++------ .../jobs_restore_auth.JobRestoreAuth.html | 32 +++++++++---------- ...restore_firestore.JobRestoreFirestore.html | 32 +++++++++---------- ...obs_restore_storage.JobRestoreStorage.html | 30 ++++++++--------- .../utils_AuthConverter.AuthConverter.html | 10 +++--- docs/classes/utils_FirebaseAuth.Auth.html | 4 +-- .../utils_FirebaseAuth.UserRecord.html | 4 +-- ...s_FirebaseFirestore.DocumentReference.html | 4 +-- .../utils_FirebaseFirestore.Firestore.html | 4 +-- .../utils_FirebaseFirestore.GeoPoint.html | 4 +-- .../utils_FirebaseFirestore.Timestamp.html | 4 +-- .../utils_FirebaseFirestore.WriteBatch.html | 4 +-- .../utils_FirebaseStorage.Storage.html | 4 +-- ...FirestoreConverter.FirestoreConverter.html | 12 +++---- docs/classes/utils_Logger.Logger.html | 12 +++---- ...ils_StorageConverter.StorageConverter.html | 8 ++--- docs/classes/utils_initialization.Writer.html | 12 +++---- ...plate.JobBackupServiceRestoreTemplate.html | 26 +++++++-------- ...ils_template.JobBackupServiceTemplate.html | 24 +++++++------- .../utils_template.JobOneServiceTemplate.html | 20 ++++++------ .../utils_template.JobOneTemplate.html | 18 +++++------ docs/classes/utils_template.JobTemplate.html | 12 +++---- ...seAdmin.credential.applicationDefault.html | 4 +-- .../utils_FirebaseAdmin.credential.cert.html | 4 +-- ...FirebaseAdmin.credential.refreshToken.html | 4 +-- .../utils_FirebaseAdmin.initializeApp.html | 2 +- .../functions/utils_FirebaseAuth.getAuth.html | 4 +-- .../utils_FirebaseFirestore.getFirestore.html | 4 +-- .../utils_FirebaseStorage.getStorage.html | 4 +-- .../utils_initialization.cmdParser.html | 4 +-- ..._initialization.createWriteFileStream.html | 4 +-- .../utils_initialization.initialization.html | 4 +-- docs/functions/utils_randomStr.randomStr.html | 4 +-- docs/hierarchy.html | 2 +- docs/index.html | 4 +-- docs/interfaces/utils_FirebaseAdmin.App.html | 4 +-- .../utils_initialization.ParsedSettings.html | 22 ++++++------- .../utils_initialization.Settings.html | 20 ++++++------ ...lization.SettingsBeforeInitialization.html | 18 +++++------ docs/interfaces/utils_template.DataModel.html | 10 +++--- docs/modules/FirebaseEngine.html | 4 +-- docs/modules/bin_firebase_engine.html | 2 +- .../bin_firebase_engine_emulators.html | 2 +- docs/modules/index.html | 2 +- docs/modules/jobs_Jobs.html | 4 +-- docs/modules/jobs_backup_auth.html | 4 +-- docs/modules/jobs_backup_firestore.html | 4 +-- docs/modules/jobs_backup_storage.html | 4 +-- docs/modules/jobs_clean_auth.html | 4 +-- docs/modules/jobs_clean_firestore.html | 4 +-- docs/modules/jobs_clean_storage.html | 4 +-- docs/modules/jobs_restore_auth.html | 4 +-- docs/modules/jobs_restore_firestore.html | 4 +-- docs/modules/jobs_restore_storage.html | 4 +-- docs/modules/utils_AuthConverter.html | 4 +-- .../utils_FirebaseAdmin.credential.html | 4 +-- docs/modules/utils_FirebaseAdmin.html | 4 +-- docs/modules/utils_FirebaseAuth.html | 4 +-- docs/modules/utils_FirebaseFirestore.html | 4 +-- docs/modules/utils_FirebaseStorage.html | 4 +-- docs/modules/utils_FirestoreConverter.html | 4 +-- docs/modules/utils_Logger.html | 4 +-- docs/modules/utils_StorageConverter.html | 4 +-- docs/modules/utils_initialization.html | 4 +-- docs/modules/utils_randomStr.html | 4 +-- docs/modules/utils_template.html | 4 +-- ...s_FirebaseAdmin.credential.Credential.html | 4 +-- .../utils_FirebaseAuth.HashAlgorithmType.html | 2 +- .../utils_FirebaseFirestore.DocumentData.html | 4 +-- docs/variables/utils_FirebaseAdmin.apps.html | 2 +- .../utils_initialization.writers.html | 4 +-- 78 files changed, 354 insertions(+), 354 deletions(-) diff --git a/docs/classes/FirebaseEngine.FirebaseEngine.html b/docs/classes/FirebaseEngine.FirebaseEngine.html index 4a126472..2fe8a762 100644 --- a/docs/classes/FirebaseEngine.FirebaseEngine.html +++ b/docs/classes/FirebaseEngine.FirebaseEngine.html @@ -1,17 +1,17 @@ -FirebaseEngine | Firebase Engine - v1.5.136

Class FirebaseEngine

Firebase Engine to copy data

-

Constructors

constructor +FirebaseEngine | Firebase Engine - v1.5.137

Class FirebaseEngine

Firebase Engine to copy data

+

Constructors

constructor

Properties

admin jobs settings store

Methods

exit

Constructors

constructor

Properties

Private admin

admin: App

firebase app

-

jobs

jobs: Jobs

Firebase Engine Jobs

-

Private settings

settings: Settings

settings object

-

Private store

store: Storage

Google cloud storage app

-

Methods

exit

Settings

Member Visibility

Theme

On This Page

constructoradminjobssettingsstoreexit
\ No newline at end of file diff --git a/docs/classes/jobs_Jobs.Jobs.html b/docs/classes/jobs_Jobs.Jobs.html index c32958fa..36bf66ea 100644 --- a/docs/classes/jobs_Jobs.Jobs.html +++ b/docs/classes/jobs_Jobs.Jobs.html @@ -1,5 +1,5 @@ -Jobs | Firebase Engine - v1.5.136

Class Jobs

Jobs Class

-

Hierarchy (view full)

Constructors

constructor +Jobs | Firebase Engine - v1.5.137

Class Jobs

Jobs Class

+

Hierarchy (view full)

Constructors

constructor

Properties

admin backup clean @@ -9,13 +9,13 @@

Constructors

constructor

Properties

admin

admin: App

firebase app

-

backup

backup: JobsBackup

backup jobs

-

clean

clean: JobsClean

clean jobs

-

restore

restore: JobsRestore

restore jobs

-

settings

settings: Settings

settings object

-

store

store: Storage

Google cloud storage app

-

Settings

Member Visibility

Theme

On This Page

constructoradminbackupcleanrestoresettingsstore
\ No newline at end of file diff --git a/docs/classes/jobs_backup_auth.JobBackupAuth.html b/docs/classes/jobs_backup_auth.JobBackupAuth.html index d6906140..36897db0 100644 --- a/docs/classes/jobs_backup_auth.JobBackupAuth.html +++ b/docs/classes/jobs_backup_auth.JobBackupAuth.html @@ -1,5 +1,5 @@ -JobBackupAuth | Firebase Engine - v1.5.136

Class JobBackupAuth

Job backup

-

Hierarchy (view full)

Constructors

constructor +JobBackupAuth | Firebase Engine - v1.5.137

Class JobBackupAuth

Job backup

+

Hierarchy (view full)

Constructors

constructor

Properties

admin auth counter @@ -14,18 +14,18 @@

Constructors

constructor

Properties

admin

admin: App

firebase app

-

Private auth

auth: Auth

firebase auth app

-

counter

counter: number = 0

operation counter

-

settings

settings: Settings

settings object

-

startTimestamp

startTimestamp: number

start timestamp

-

store

store: Storage

Google cloud storage app

-

stringiferStream

stringiferStream: Transform

object to string stream

-

writer

writer: Writer

Writer streams in object

-

Methods

getWorkTime

Private recursiveBackup

  • recursiveBackup(nextPageToken?): Promise<void>

  • recursive backup function

    -

    Parameters

    • Optional nextPageToken: string

    Returns Promise<void>

run

Settings

Member Visibility

Theme

On This Page

constructoradminauthcountersettingsstartTimestampstorestringiferStreamwritergetWorkTimerecursiveBackuprun
\ No newline at end of file diff --git a/docs/classes/jobs_backup_firestore.JobBackupFirestore.html b/docs/classes/jobs_backup_firestore.JobBackupFirestore.html index d1f50dca..fd99a4d7 100644 --- a/docs/classes/jobs_backup_firestore.JobBackupFirestore.html +++ b/docs/classes/jobs_backup_firestore.JobBackupFirestore.html @@ -1,5 +1,5 @@ -JobBackupFirestore | Firebase Engine - v1.5.136

Class JobBackupFirestore

Job backup

-

Hierarchy (view full)

Constructors

constructor +JobBackupFirestore | Firebase Engine - v1.5.137

Class JobBackupFirestore

Job backup

+

Hierarchy (view full)

Constructors

constructor

Properties

admin counter firestore @@ -15,19 +15,19 @@

Constructors

constructor

Properties

admin

admin: App

firebase app

-

counter

counter: number = 0

operation counter

-

Private firestore

firestore: Firestore

firebase firestore app

-

settings

settings: Settings

settings object

-

startTimestamp

startTimestamp: number

start timestamp

-

store

store: Storage

Google cloud storage app

-

stringiferStream

stringiferStream: Transform

object to string stream

-

writer

writer: Writer

Writer streams in object

-

Methods

Private documentBackup

getWorkTime

Private recursiveBackup

run

Settings

Member Visibility

Theme

On This Page

constructoradmincounterfirestoresettingsstartTimestampstorestringiferStreamwriterdocumentBackupgetWorkTimerecursiveBackuprun
\ No newline at end of file diff --git a/docs/classes/jobs_backup_storage.JobBackupStorage.html b/docs/classes/jobs_backup_storage.JobBackupStorage.html index 39e02e97..94b17d37 100644 --- a/docs/classes/jobs_backup_storage.JobBackupStorage.html +++ b/docs/classes/jobs_backup_storage.JobBackupStorage.html @@ -1,5 +1,5 @@ -JobBackupStorage | Firebase Engine - v1.5.136

Class JobBackupStorage

Job backup

-

Hierarchy (view full)

Constructors

constructor +JobBackupStorage | Firebase Engine - v1.5.137

Class JobBackupStorage

Job backup

+

Hierarchy (view full)

Constructors

constructor

Properties

admin counter settings @@ -13,17 +13,17 @@

Constructors

constructor

Properties

admin

admin: App

firebase app

-

counter

counter: number = 0

operation counter

-

settings

settings: Settings

settings object

-

startTimestamp

startTimestamp: number

start timestamp

-

store

store: Storage

Google cloud storage app

-

stringiferStream

stringiferStream: Transform

object to string stream

-

writer

writer: Writer

Writer streams in object

-

Methods

Private backupFile

  • backupFile(bucket, file): Promise<void>

  • backup one file function

    -

    Parameters

    • bucket: Bucket
    • file: File

    Returns Promise<void>

getWorkTime

run

Settings

Member Visibility

Theme

On This Page

constructoradmincountersettingsstartTimestampstorestringiferStreamwriterbackupFilegetWorkTimerun
\ No newline at end of file diff --git a/docs/classes/jobs_clean_auth.JobCleanAuth.html b/docs/classes/jobs_clean_auth.JobCleanAuth.html index 7c6e4f49..fa3a58db 100644 --- a/docs/classes/jobs_clean_auth.JobCleanAuth.html +++ b/docs/classes/jobs_clean_auth.JobCleanAuth.html @@ -1,5 +1,5 @@ -JobCleanAuth | Firebase Engine - v1.5.136

Class JobCleanAuth

Job class

-

Hierarchy (view full)

Constructors

constructor +JobCleanAuth | Firebase Engine - v1.5.137

Class JobCleanAuth

Job class

+

Hierarchy (view full)

Constructors

constructor

Properties

admin auth counter @@ -12,16 +12,16 @@

Constructors

constructor

Properties

admin

admin: App

firebase app

-

Private auth

auth: Auth

firebase auth app

-

counter

counter: number = 0

operation counter

-

settings

settings: Settings

settings object

-

startTimestamp

startTimestamp: number

start timestamp

-

store

store: Storage

Google cloud storage app

-

Methods

getWorkTime

Private recursiveClean

  • recursiveClean(nextPageToken?): Promise<void>

  • recursive clean function

    -

    Parameters

    • Optional nextPageToken: string

    Returns Promise<void>

run

Settings

Member Visibility

Theme

On This Page

constructoradminauthcountersettingsstartTimestampstoregetWorkTimerecursiveCleanrun
\ No newline at end of file diff --git a/docs/classes/jobs_clean_firestore.JobCleanFirestore.html b/docs/classes/jobs_clean_firestore.JobCleanFirestore.html index 94cf8ad8..8a3e4588 100644 --- a/docs/classes/jobs_clean_firestore.JobCleanFirestore.html +++ b/docs/classes/jobs_clean_firestore.JobCleanFirestore.html @@ -1,5 +1,5 @@ -JobCleanFirestore | Firebase Engine - v1.5.136

Class JobCleanFirestore

Job class

-

Hierarchy (view full)

Constructors

constructor +JobCleanFirestore | Firebase Engine - v1.5.137

Class JobCleanFirestore

Job class

+

Hierarchy (view full)

Constructors

constructor

Properties

admin batch counter @@ -15,19 +15,19 @@

Constructors

constructor

Properties

admin

admin: App

firebase app

-

Private batch

batch: WriteBatch

batch object

-

counter

counter: number = 0

operation counter

-

Private firestore

firestore: Firestore

firebase firestore app

-

settings

settings: Settings

settings object

-

startTimestamp

startTimestamp: number

start timestamp

-

store

store: Storage

Google cloud storage app

-

Static Private batchSize

batchSize: number = 500

document on one batch

-

Methods

Private batchClean

getWorkTime

Private recursiveClean

run

Settings

Member Visibility

Theme

On This Page

constructoradminbatchcounterfirestoresettingsstartTimestampstorebatchSizebatchCleangetWorkTimerecursiveCleanrun
\ No newline at end of file diff --git a/docs/classes/jobs_clean_storage.JobCleanStorage.html b/docs/classes/jobs_clean_storage.JobCleanStorage.html index 82c4831d..461e7a2e 100644 --- a/docs/classes/jobs_clean_storage.JobCleanStorage.html +++ b/docs/classes/jobs_clean_storage.JobCleanStorage.html @@ -1,5 +1,5 @@ -JobCleanStorage | Firebase Engine - v1.5.136

Class JobCleanStorage

Job class

-

Hierarchy (view full)

Constructors

constructor +JobCleanStorage | Firebase Engine - v1.5.137

Class JobCleanStorage

Job class

+

Hierarchy (view full)

Constructors

constructor

Properties

admin counter settings @@ -10,14 +10,14 @@

Constructors

constructor

Properties

admin

admin: App

firebase app

-

counter

counter: number = 0

operation counter

-

settings

settings: Settings

settings object

-

startTimestamp

startTimestamp: number

start timestamp

-

store

store: Storage

Google cloud storage app

-

Methods

getWorkTime

run

Settings

Member Visibility

Theme

On This Page

constructoradmincountersettingsstartTimestampstoregetWorkTimerun
\ No newline at end of file diff --git a/docs/classes/jobs_restore_auth.JobRestoreAuth.html b/docs/classes/jobs_restore_auth.JobRestoreAuth.html index 37e286cb..53480c5f 100644 --- a/docs/classes/jobs_restore_auth.JobRestoreAuth.html +++ b/docs/classes/jobs_restore_auth.JobRestoreAuth.html @@ -1,5 +1,5 @@ -JobRestoreAuth | Firebase Engine - v1.5.136

Class JobRestoreAuth

Job restore

-

Hierarchy (view full)

Constructors

constructor +JobRestoreAuth | Firebase Engine - v1.5.137

Class JobRestoreAuth

Job restore

+

Hierarchy (view full)

Constructors

constructor

Properties

admin auth counter @@ -16,26 +16,26 @@

Constructors

constructor

Properties

admin

admin: App

firebase app

-

Private auth

auth: Auth

firebase auth app

-

counter

counter: number = 0

operation counter

-

fileStream

fileStream: ReadStream

file read stream

-

Optional gunzipStream

gunzipStream?: Gunzip

unzip stream

-

parserStream

parserStream: Transform

string to object stream

-

settings

settings: Settings

settings object

-

startTimestamp

startTimestamp: number

start timestamp

-

store

store: Storage

Google cloud storage app

-

Private writeBuffer

writeBuffer: {
    batch: {
        uid: string;
        [key: string]: any;
    }[];
    batchSize: number;
    clear: Function;
    commit: Function;
    iteration: number;
    set: Function;
}

buffer for write to project

+

Returns JobRestoreAuth

Properties

admin

admin: App

firebase app

+

Private auth

auth: Auth

firebase auth app

+

counter

counter: number = 0

operation counter

+

fileStream

fileStream: ReadStream

file read stream

+

Optional gunzipStream

gunzipStream?: Gunzip

unzip stream

+

parserStream

parserStream: Transform

string to object stream

+

settings

settings: Settings

settings object

+

startTimestamp

startTimestamp: number

start timestamp

+

store

store: Storage

Google cloud storage app

+

Private writeBuffer

writeBuffer: {
    batch: {
        uid: string;
        [key: string]: any;
    }[];
    batchSize: number;
    clear: Function;
    commit: Function;
    iteration: number;
    set: Function;
}

buffer for write to project

Type declaration

  • batch: {
        uid: string;
        [key: string]: any;
    }[]

    array of user

  • batchSize: number

    batch size

  • clear: Function

    clean this buffer

  • commit: Function

    write this buffer to project and clean it

  • iteration: number

    iteration

  • set: Function

    add user to this buffer

    -

Private writeStream

writeStream: Writable

write user to project stream

-

Methods

getWorkTime

run

Settings

Member Visibility

Theme

On This Page

constructoradminauthcounterfileStreamgunzipStreamparserStreamsettingsstartTimestampstorewriteBufferwriteStreamgetWorkTimerun
\ No newline at end of file diff --git a/docs/classes/jobs_restore_firestore.JobRestoreFirestore.html b/docs/classes/jobs_restore_firestore.JobRestoreFirestore.html index 14fcc7d6..b9a3c0e6 100644 --- a/docs/classes/jobs_restore_firestore.JobRestoreFirestore.html +++ b/docs/classes/jobs_restore_firestore.JobRestoreFirestore.html @@ -1,5 +1,5 @@ -JobRestoreFirestore | Firebase Engine - v1.5.136

Class JobRestoreFirestore

Job restore

-

Hierarchy (view full)

Constructors

constructor +JobRestoreFirestore | Firebase Engine - v1.5.137

Class JobRestoreFirestore

Job restore

+

Hierarchy (view full)

Constructors

constructor

Properties

admin counter fileStream @@ -16,26 +16,26 @@

Constructors

constructor

Properties

admin

admin: App

firebase app

-

counter

counter: number = 0

operation counter

-

fileStream

fileStream: ReadStream

file read stream

-

Private firestore

firestore: Firestore

firebase firestore app

-

Optional gunzipStream

gunzipStream?: Gunzip

unzip stream

-

parserStream

parserStream: Transform

string to object stream

-

settings

settings: Settings

settings object

-

startTimestamp

startTimestamp: number

start timestamp

-

store

store: Storage

Google cloud storage app

-

Private writeBuffer

writeBuffer: {
    batch: WriteBatch;
    batchSize: number;
    clear: Function;
    commit: Function;
    iteration: number;
    set: Function;
}

buffer for write to project

+

Returns JobRestoreFirestore

Properties

admin

admin: App

firebase app

+

counter

counter: number = 0

operation counter

+

fileStream

fileStream: ReadStream

file read stream

+

Private firestore

firestore: Firestore

firebase firestore app

+

Optional gunzipStream

gunzipStream?: Gunzip

unzip stream

+

parserStream

parserStream: Transform

string to object stream

+

settings

settings: Settings

settings object

+

startTimestamp

startTimestamp: number

start timestamp

+

store

store: Storage

Google cloud storage app

+

Private writeBuffer

writeBuffer: {
    batch: WriteBatch;
    batchSize: number;
    clear: Function;
    commit: Function;
    iteration: number;
    set: Function;
}

buffer for write to project

Type declaration

  • batch: WriteBatch

    Firestore Writebatch

  • batchSize: number

    batch size

  • clear: Function

    clean this buffer

  • commit: Function

    write this buffer to project and clean it

  • iteration: number

    iteration

  • set: Function

    add document to this buffer

    -

Private writeStream

writeStream: Writable

write document to project stream

-

Methods

getWorkTime

run

Settings

Member Visibility

Theme

On This Page

constructoradmincounterfileStreamfirestoregunzipStreamparserStreamsettingsstartTimestampstorewriteBufferwriteStreamgetWorkTimerun
\ No newline at end of file diff --git a/docs/classes/jobs_restore_storage.JobRestoreStorage.html b/docs/classes/jobs_restore_storage.JobRestoreStorage.html index 6100c757..34549601 100644 --- a/docs/classes/jobs_restore_storage.JobRestoreStorage.html +++ b/docs/classes/jobs_restore_storage.JobRestoreStorage.html @@ -1,5 +1,5 @@ -JobRestoreStorage | Firebase Engine - v1.5.136

Class JobRestoreStorage

Job restore

-

Hierarchy (view full)

Constructors

constructor +JobRestoreStorage | Firebase Engine - v1.5.137

Class JobRestoreStorage

Job restore

+

Hierarchy (view full)

Constructors

constructor

Properties

admin buckets counter @@ -15,19 +15,19 @@

Constructors

constructor

Properties

admin

admin: App

firebase app

-

Private buckets

buckets: string[]

Array of google storage bucket name

-

counter

counter: number = 0

operation counter

-

fileStream

fileStream: ReadStream

file read stream

-

Optional gunzipStream

gunzipStream?: Gunzip

unzip stream

-

parserStream

parserStream: Transform

string to object stream

-

settings

settings: Settings

settings object

-

startTimestamp

startTimestamp: number

start timestamp

-

store

store: Storage

Google cloud storage app

-

Private writeStream

writeStream: Writable

write file to project stream

-

Methods

getWorkTime

run

Settings

Member Visibility

Theme

On This Page

constructoradminbucketscounterfileStreamgunzipStreamparserStreamsettingsstartTimestampstorewriteStreamgetWorkTimerun
\ No newline at end of file diff --git a/docs/classes/utils_AuthConverter.AuthConverter.html b/docs/classes/utils_AuthConverter.AuthConverter.html index df4b64f2..653dc660 100644 --- a/docs/classes/utils_AuthConverter.AuthConverter.html +++ b/docs/classes/utils_AuthConverter.AuthConverter.html @@ -1,16 +1,16 @@ -AuthConverter | Firebase Engine - v1.5.136

Class AuthConverter

Auth Document converter

-

Constructors

constructor +AuthConverter | Firebase Engine - v1.5.137

Class AuthConverter

Auth Document converter

+

Constructors

constructor

Properties

userField

Methods

fromString toString

Constructors

constructor

Properties

Static Private userField

userField: string[] = ...

Copy only the allowed fields, otherwise the object breaks inside firebase.auth (after recovery)

-

Methods

Static fromString

  • fromString(d, restorePassword?): {
        uid: string;
        [key: string]: any;
    }

  • Convert string to object

    +

Methods

Static fromString

  • fromString(d, restorePassword?): {
        uid: string;
        [key: string]: any;
    }

  • Convert string to object

    Parameters

    • d: string

      String to convert

      -
    • restorePassword: boolean = false

    Returns {
        uid: string;
        [key: string]: any;
    }

    • [key: string]: any
    • uid: string

Static toString

  • toString(d): string

  • Convert an object to a string

    +
  • restorePassword: boolean = false

Returns {
    uid: string;
    [key: string]: any;
}

  • [key: string]: any
  • uid: string

Static toString

Settings

Member Visibility

Theme

On This Page

constructoruserFieldfromStringtoString
\ No newline at end of file diff --git a/docs/classes/utils_FirebaseAuth.Auth.html b/docs/classes/utils_FirebaseAuth.Auth.html index b711369b..7baf23d6 100644 --- a/docs/classes/utils_FirebaseAuth.Auth.html +++ b/docs/classes/utils_FirebaseAuth.Auth.html @@ -1,4 +1,4 @@ -Auth | Firebase Engine - v1.5.136

Class Auth

Auth service bound to the provided app. +Auth | Firebase Engine - v1.5.137

Class Auth

Auth service bound to the provided app. An Auth instance can have multiple tenants.

Hierarchy

  • BaseAuth
    • Auth

Constructors

constructor

Properties

app_ @@ -360,7 +360,7 @@
  • Optional checkRevoked: boolean

    • Returns Promise<DecodedIdToken>

    A promise fulfilled with the session cookie's decoded claims if the session cookie is valid; otherwise, a rejected promise.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorapp_projectConfigManager_tenantManager_app_verifyAuthBlockingTokencreateCustomTokencreateProviderConfigcreateSessionCookiecreateUserdeleteProviderConfigdeleteUserdeleteUsersgenerateEmailVerificationLinkgeneratePasswordResetLinkgenerateSignInWithEmailLinkgenerateVerifyAndChangeEmailLinkgetProviderConfiggetUsergetUserByEmailgetUserByPhoneNumbergetUserByProviderUidgetUsersimportUserslistProviderConfigslistUsersprojectConfigManagerrevokeRefreshTokenssetCustomUserClaimstenantManagerupdateProviderConfigupdateUserverifyIdTokenverifySessionCookie
    \ No newline at end of file diff --git a/docs/classes/utils_FirebaseAuth.UserRecord.html b/docs/classes/utils_FirebaseAuth.UserRecord.html index 76304f85..c9700c2b 100644 --- a/docs/classes/utils_FirebaseAuth.UserRecord.html +++ b/docs/classes/utils_FirebaseAuth.UserRecord.html @@ -1,4 +1,4 @@ -UserRecord | Firebase Engine - v1.5.136

    Class UserRecord

    Represents a user.

    +UserRecord | Firebase Engine - v1.5.137

    Class UserRecord

    Represents a user.

    Constructors

    constructor

    Properties

    customClaims? disabled @@ -49,7 +49,7 @@

    Readonly uid

    uid: string

    The user's uid.

    Methods

    toJSON

    • toJSON(): object

    • Returns a JSON-serializable representation of this object.

      Returns object

      A JSON-serializable representation of this object.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcustomClaimsdisableddisplayNameemailemailVerifiedmetadatamultiFactorpasswordHashpasswordSaltphoneNumberphotoURLproviderDatatenantIdtokensValidAfterTimeuidtoJSON
    \ No newline at end of file diff --git a/docs/classes/utils_FirebaseFirestore.DocumentReference.html b/docs/classes/utils_FirebaseFirestore.DocumentReference.html index 7b82f80b..ffe9dc21 100644 --- a/docs/classes/utils_FirebaseFirestore.DocumentReference.html +++ b/docs/classes/utils_FirebaseFirestore.DocumentReference.html @@ -1,4 +1,4 @@ -DocumentReference | Firebase Engine - v1.5.136

    Class DocumentReference<AppModelType, DbModelType>

    A DocumentReference refers to a document location in a Firestore database +DocumentReference | Firebase Engine - v1.5.137

    Class DocumentReference<AppModelType, DbModelType>

    A DocumentReference refers to a document location in a Firestore database and can be used to write, read, or listen to the location. The document at the referenced location may or may not exist. A DocumentReference can also be used to create a CollectionReference to a subcollection.

    @@ -87,7 +87,7 @@

    Type Parameters

    Parameters

    • converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>

      Converts objects to and from Firestore. Passing in null removes the current converter.

    Returns DocumentReference<NewAppModelType, NewDbModelType>

    A DocumentReference that uses the provided converter.

    -
  • withConverter(converter): DocumentReference<DocumentData, DocumentData>

  • Parameters

    • converter: null

    Returns DocumentReference<DocumentData, DocumentData>

    • Settings

    Member Visibility

    Theme

    On This Page

    constructorfirestoreidparentpathcollectioncreatedeletegetisEquallistCollectionsonSnapshotsetupdatewithConverter
    \ No newline at end of file diff --git a/docs/classes/utils_FirebaseFirestore.Firestore.html b/docs/classes/utils_FirebaseFirestore.Firestore.html index 288b324b..bbfc057f 100644 --- a/docs/classes/utils_FirebaseFirestore.Firestore.html +++ b/docs/classes/utils_FirebaseFirestore.Firestore.html @@ -1,4 +1,4 @@ -Firestore | Firebase Engine - v1.5.136

    Class Firestore

    Firestore represents a Firestore Database and is the entry point for all +Firestore | Firebase Engine - v1.5.137

    Class Firestore

    Firestore represents a Firestore Database and is the entry point for all Firestore operations.

    Constructors

    constructor

    Methods

    batch @@ -111,7 +111,7 @@ operations.

    Returns void

    terminate

    • terminate(): Promise<void>

    • Terminates the Firestore client and closes all open streams.

      Returns Promise<void>

      A Promise that resolves when the client is terminated.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorbatchbulkWriterbundlecollectioncollectionGroupdocgetAlllistCollectionsrecursiveDeleterunTransactionsettingsterminate
    \ No newline at end of file diff --git a/docs/classes/utils_FirebaseFirestore.GeoPoint.html b/docs/classes/utils_FirebaseFirestore.GeoPoint.html index 83f4a408..c40eff6f 100644 --- a/docs/classes/utils_FirebaseFirestore.GeoPoint.html +++ b/docs/classes/utils_FirebaseFirestore.GeoPoint.html @@ -1,4 +1,4 @@ -GeoPoint | Firebase Engine - v1.5.136

    Class GeoPoint

    An immutable object representing a geo point in Firestore. The geo point +GeoPoint | Firebase Engine - v1.5.137

    Class GeoPoint

    An immutable object representing a geo point in Firestore. The geo point is represented as latitude/longitude pair.

    Latitude values are in the range of [-90, 90]. Longitude values are in the range of [-180, 180].

    @@ -13,7 +13,7 @@

    Returns GeoPoint

    Properties

    Readonly latitude

    latitude: number

    Readonly longitude

    longitude: number

    Methods

    isEqual

    • isEqual(other): boolean

    • Returns true if this GeoPoint is equal to the provided one.

      Parameters

      • other: GeoPoint

        The GeoPoint to compare against.

      Returns boolean

      true if this GeoPoint is equal to the provided one.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorlatitudelongitudeisEqual
    \ No newline at end of file diff --git a/docs/classes/utils_FirebaseFirestore.Timestamp.html b/docs/classes/utils_FirebaseFirestore.Timestamp.html index a43ef71f..d2ddf363 100644 --- a/docs/classes/utils_FirebaseFirestore.Timestamp.html +++ b/docs/classes/utils_FirebaseFirestore.Timestamp.html @@ -1,4 +1,4 @@ -Timestamp | Firebase Engine - v1.5.136

    Class Timestamp

    A Timestamp represents a point in time independent of any time zone or +Timestamp | Firebase Engine - v1.5.137

    Class Timestamp

    A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is @@ -50,7 +50,7 @@ given number of milliseconds.

    Static now

    • now(): Timestamp

    • Creates a new timestamp with the current date, with millisecond precision.

      Returns Timestamp

      A new Timestamp representing the current date.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    constructornanosecondssecondsisEqualtoDatetoMillisvalueOffromDatefromMillisnow
    \ No newline at end of file diff --git a/docs/classes/utils_FirebaseFirestore.WriteBatch.html b/docs/classes/utils_FirebaseFirestore.WriteBatch.html index 2500cc8b..5662acbd 100644 --- a/docs/classes/utils_FirebaseFirestore.WriteBatch.html +++ b/docs/classes/utils_FirebaseFirestore.WriteBatch.html @@ -1,4 +1,4 @@ -WriteBatch | Firebase Engine - v1.5.136

    Class WriteBatch

    A write batch, used to perform multiple writes as a single atomic unit.

    +WriteBatch | Firebase Engine - v1.5.137

    Class WriteBatch

    A write batch, used to perform multiple writes as a single atomic unit.

    A WriteBatch object can be acquired by calling Firestore.batch(). It provides methods for adding writes to the write batch. None of the writes will be committed (or visible locally) until WriteBatch.commit() @@ -59,7 +59,7 @@ update.

    Returns WriteBatch

    This WriteBatch instance. Used for chaining method calls.

    Throws

    Error If the provided input is not valid Firestore data.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcommitcreatedeletesetupdate
    \ No newline at end of file diff --git a/docs/classes/utils_FirebaseStorage.Storage.html b/docs/classes/utils_FirebaseStorage.Storage.html index f774eb16..9fb4bc15 100644 --- a/docs/classes/utils_FirebaseStorage.Storage.html +++ b/docs/classes/utils_FirebaseStorage.Storage.html @@ -1,4 +1,4 @@ -Storage | Firebase Engine - v1.5.136

    Class Storage

    The default Storage service if no +Storage | Firebase Engine - v1.5.137

    Class Storage

    The default Storage service if no app is provided or the Storage service associated with the provided app.

    Constructors

    constructor @@ -13,7 +13,7 @@ retrieves a reference to the default bucket.

    Returns Bucket

    A Bucket instance as defined in the @google-cloud/storage package.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorappInternalstorageClientappbucket
    \ No newline at end of file diff --git a/docs/classes/utils_FirestoreConverter.FirestoreConverter.html b/docs/classes/utils_FirestoreConverter.FirestoreConverter.html index 595c9152..b0681228 100644 --- a/docs/classes/utils_FirestoreConverter.FirestoreConverter.html +++ b/docs/classes/utils_FirestoreConverter.FirestoreConverter.html @@ -1,18 +1,18 @@ -FirestoreConverter | Firebase Engine - v1.5.136

    Class FirestoreConverter

    Firestore Document converter

    -

    Constructors

    constructor +FirestoreConverter | Firebase Engine - v1.5.137

    Class FirestoreConverter

    Firestore Document converter

    +

    Constructors

    constructor

    Methods

    fromObject fromString toObject toString

    Constructors

    constructor

    Methods

    Static Private fromObject

    Static fromString

    • fromString(d): any

    • Convert string to object

      +

    Returns any

    Static fromString

    Static Private toObject

    • toObject(d): {
          data: any;
          type: string;
      }

    • Internal deserialization

      +

    Returns any

    Static Private toObject

    • toObject(d): {
          data: any;
          type: string;
      }

    • Internal deserialization

      Parameters

      • d: any

        Object for deserialization

        -

      Returns {
          data: any;
          type: string;
      }

      • data: any
      • type: string

    Static toString

    • toString(d): string

    • Convert an object to a string

      +

    Returns {
        data: any;
        type: string;
    }

    • data: any
    • type: string

    Static toString

    • toString(d): string

    • Convert an object to a string

      Parameters

      • d: {
            [key: string]: any;
        }

        Object for convert

        -
        • [key: string]: any

      Returns string

    Settings

    Member Visibility

    Theme

    On This Page

    constructorfromObjectfromStringtoObjecttoString
    \ No newline at end of file diff --git a/docs/classes/utils_Logger.Logger.html b/docs/classes/utils_Logger.Logger.html index 81b5a280..454de4c1 100644 --- a/docs/classes/utils_Logger.Logger.html +++ b/docs/classes/utils_Logger.Logger.html @@ -1,14 +1,14 @@ -Logger | Firebase Engine - v1.5.136

    Class Logger

    Logger class

    -

    Constructors

    constructor +Logger | Firebase Engine - v1.5.137

    Class Logger

    Logger class

    +

    Constructors

    constructor

    Methods

    error log table warn

    Constructors

    constructor

    Methods

    Static error

    Static log

    Static table

    Static warn

    Settings

    Member Visibility

    Theme

    On This Page

    constructorerrorlogtablewarn
    \ No newline at end of file diff --git a/docs/classes/utils_StorageConverter.StorageConverter.html b/docs/classes/utils_StorageConverter.StorageConverter.html index e9d52d14..b3a968cf 100644 --- a/docs/classes/utils_StorageConverter.StorageConverter.html +++ b/docs/classes/utils_StorageConverter.StorageConverter.html @@ -1,12 +1,12 @@ -StorageConverter | Firebase Engine - v1.5.136

    Class StorageConverter

    Storage File converter

    -

    Constructors

    constructor +StorageConverter | Firebase Engine - v1.5.137

    Class StorageConverter

    Storage File converter

    +

    Constructors

    constructor

    Methods

    fromString toString

    Constructors

    constructor

    Methods

    Static fromString

    Static toString

    • toString(d): string

    • Convert an object to a string

      +

    Returns Buffer

    Static toString

    Settings

    Member Visibility

    Theme

    On This Page

    constructorfromStringtoString
    \ No newline at end of file diff --git a/docs/classes/utils_initialization.Writer.html b/docs/classes/utils_initialization.Writer.html index 39cc5292..1ae309bc 100644 --- a/docs/classes/utils_initialization.Writer.html +++ b/docs/classes/utils_initialization.Writer.html @@ -1,13 +1,13 @@ -Writer | Firebase Engine - v1.5.136

    Class Writer

    Writer Class for create write streams

    -

    Constructors

    constructor +Writer | Firebase Engine - v1.5.137

    Class Writer

    Writer Class for create write streams

    +

    Constructors

    constructor

    Properties

    compress fileStream gzipStream?

    Constructors

    constructor

    Properties

    compress

    compress: boolean = false

    use compress

    -

    fileStream

    fileStream: WriteStream

    file write stream after gzipped

    -

    Optional gzipStream

    gzipStream?: Gzip

    gzip stream

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcompressfileStreamgzipStream
    \ No newline at end of file diff --git a/docs/classes/utils_template.JobBackupServiceRestoreTemplate.html b/docs/classes/utils_template.JobBackupServiceRestoreTemplate.html index 7178cda9..61ca46e5 100644 --- a/docs/classes/utils_template.JobBackupServiceRestoreTemplate.html +++ b/docs/classes/utils_template.JobBackupServiceRestoreTemplate.html @@ -1,5 +1,5 @@ -JobBackupServiceRestoreTemplate | Firebase Engine - v1.5.136

    Class JobBackupServiceRestoreTemplate

    Job restore

    -

    Hierarchy (view full)

    Constructors

    constructor +JobBackupServiceRestoreTemplate | Firebase Engine - v1.5.137

    Class JobBackupServiceRestoreTemplate

    Job restore

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    admin counter fileStream @@ -13,17 +13,17 @@

    Constructors

    constructor

    Properties

    admin

    admin: App

    firebase app

    -

    counter

    counter: number = 0

    operation counter

    -

    fileStream

    fileStream: ReadStream

    file read stream

    -

    Optional gunzipStream

    gunzipStream?: Gunzip

    unzip stream

    -

    parserStream

    parserStream: Transform

    string to object stream

    -

    settings

    settings: Settings

    settings object

    -

    startTimestamp

    startTimestamp: number

    start timestamp

    -

    store

    store: Storage

    Google cloud storage app

    -

    Methods

    getWorkTime

    run

    Settings

    Member Visibility

    Theme

    On This Page

    constructoradmincounterfileStreamgunzipStreamparserStreamsettingsstartTimestampstoregetWorkTimerun
    \ No newline at end of file diff --git a/docs/classes/utils_template.JobBackupServiceTemplate.html b/docs/classes/utils_template.JobBackupServiceTemplate.html index 09050229..8a9b312d 100644 --- a/docs/classes/utils_template.JobBackupServiceTemplate.html +++ b/docs/classes/utils_template.JobBackupServiceTemplate.html @@ -1,5 +1,5 @@ -JobBackupServiceTemplate | Firebase Engine - v1.5.136

    Class JobBackupServiceTemplate

    Job backup

    -

    Hierarchy (view full)

    Constructors

    constructor +JobBackupServiceTemplate | Firebase Engine - v1.5.137

    Class JobBackupServiceTemplate

    Job backup

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    admin counter settings @@ -12,16 +12,16 @@

    Constructors

    constructor

    Properties

    admin

    admin: App

    firebase app

    -

    counter

    counter: number = 0

    operation counter

    -

    settings

    settings: Settings

    settings object

    -

    startTimestamp

    startTimestamp: number

    start timestamp

    -

    store

    store: Storage

    Google cloud storage app

    -

    stringiferStream

    stringiferStream: Transform

    object to string stream

    -

    writer

    writer: Writer

    Writer streams in object

    -

    Methods

    getWorkTime

    run

    Settings

    Member Visibility

    Theme

    On This Page

    constructoradmincountersettingsstartTimestampstorestringiferStreamwritergetWorkTimerun
    \ No newline at end of file diff --git a/docs/classes/utils_template.JobOneServiceTemplate.html b/docs/classes/utils_template.JobOneServiceTemplate.html index 1ff4ee10..ae2657e9 100644 --- a/docs/classes/utils_template.JobOneServiceTemplate.html +++ b/docs/classes/utils_template.JobOneServiceTemplate.html @@ -1,5 +1,5 @@ -JobOneServiceTemplate | Firebase Engine - v1.5.136

    Class JobOneServiceTemplate

    Job class

    -

    Hierarchy (view full)

    Constructors

    constructor +JobOneServiceTemplate | Firebase Engine - v1.5.137

    Class JobOneServiceTemplate

    Job class

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    admin counter settings @@ -10,14 +10,14 @@

    Constructors

    constructor

    Properties

    admin

    admin: App

    firebase app

    -

    counter

    counter: number = 0

    operation counter

    -

    settings

    settings: Settings

    settings object

    -

    startTimestamp

    startTimestamp: number

    start timestamp

    -

    store

    store: Storage

    Google cloud storage app

    -

    Methods

    getWorkTime

    run

    Settings

    Member Visibility

    Theme

    On This Page

    constructoradmincountersettingsstartTimestampstoregetWorkTimerun
    \ No newline at end of file diff --git a/docs/classes/utils_template.JobOneTemplate.html b/docs/classes/utils_template.JobOneTemplate.html index c1a80064..a1aadea4 100644 --- a/docs/classes/utils_template.JobOneTemplate.html +++ b/docs/classes/utils_template.JobOneTemplate.html @@ -1,5 +1,5 @@ -JobOneTemplate | Firebase Engine - v1.5.136

    Class JobOneTemplate

    Job One Template Class

    -

    Hierarchy (view full)

    Constructors

    constructor +JobOneTemplate | Firebase Engine - v1.5.137

    Class JobOneTemplate

    Job One Template Class

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    admin settings store @@ -9,13 +9,13 @@

    Constructors

    constructor

    Properties

    admin

    admin: App

    firebase app

    -

    settings

    settings: Settings

    settings object

    -

    store

    store: Storage

    Google cloud storage app

    -

    Methods

    auth

    firestore

    storage

    Settings

    Member Visibility

    Theme

    On This Page

    constructoradminsettingsstoreauthfirestorestorage
    \ No newline at end of file diff --git a/docs/classes/utils_template.JobTemplate.html b/docs/classes/utils_template.JobTemplate.html index ce08b9e8..fd088db3 100644 --- a/docs/classes/utils_template.JobTemplate.html +++ b/docs/classes/utils_template.JobTemplate.html @@ -1,15 +1,15 @@ -JobTemplate | Firebase Engine - v1.5.136

    Class JobTemplate

    Job Template Class

    -

    Hierarchy (view full)

    Constructors

    constructor +JobTemplate | Firebase Engine - v1.5.137

    Class JobTemplate

    Job Template Class

    +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    admin settings store

    Constructors

    constructor

    Properties

    admin

    admin: App

    firebase app

    -

    settings

    settings: Settings

    settings object

    -

    store

    store: Storage

    Google cloud storage app

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructoradminsettingsstore
    \ No newline at end of file diff --git a/docs/functions/utils_FirebaseAdmin.credential.applicationDefault.html b/docs/functions/utils_FirebaseAdmin.credential.applicationDefault.html index 61a1ba46..9003a9e2 100644 --- a/docs/functions/utils_FirebaseAdmin.credential.applicationDefault.html +++ b/docs/functions/utils_FirebaseAdmin.credential.applicationDefault.html @@ -1,4 +1,4 @@ -applicationDefault | Firebase Engine - v1.5.136

    Function applicationDefault

    • applicationDefault(httpAgent?): Credential

    • Returns a credential created from the +applicationDefault | Firebase Engine - v1.5.137

      Function applicationDefault

      • applicationDefault(httpAgent?): Credential

      • Returns a credential created from the Google Application Default Credentials that grants admin access to Firebase services. This credential can be used in the call to firebase-admin.app#initializeApp.

        @@ -13,7 +13,7 @@ Application Default Credentials that can be used to initialize an app.

        Example

        admin.initializeApp({
          credential: admin.credential.applicationDefault(),
          databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
        });
        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/functions/utils_FirebaseAdmin.credential.cert.html b/docs/functions/utils_FirebaseAdmin.credential.cert.html index e075c99e..b96a1422 100644 --- a/docs/functions/utils_FirebaseAdmin.credential.cert.html +++ b/docs/functions/utils_FirebaseAdmin.credential.cert.html @@ -1,4 +1,4 @@ -cert | Firebase Engine - v1.5.136

      Function cert

      • cert(serviceAccountPathOrObject, httpAgent?): Credential

      • Returns a credential created from the provided service account that grants +cert | Firebase Engine - v1.5.137

        Function cert

        • cert(serviceAccountPathOrObject, httpAgent?): Credential

        • Returns a credential created from the provided service account that grants admin access to Firebase services. This credential can be used in the call to firebase-admin.app#initializeApp.

          See @@ -14,7 +14,7 @@

          Example

          // Providing a service account object inline
          admin.initializeApp({
            credential: admin.credential.cert({
              projectId: "<PROJECT_ID>",
              clientEmail: "foo@<PROJECT_ID>.iam.gserviceaccount.com",
              privateKey: "-----BEGIN PRIVATE KEY-----<KEY>-----END PRIVATE KEY-----\n"
            }),
            databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
          });
          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/docs/functions/utils_FirebaseAdmin.credential.refreshToken.html b/docs/functions/utils_FirebaseAdmin.credential.refreshToken.html index d4cef915..69d5a846 100644 --- a/docs/functions/utils_FirebaseAdmin.credential.refreshToken.html +++ b/docs/functions/utils_FirebaseAdmin.credential.refreshToken.html @@ -1,4 +1,4 @@ -refreshToken | Firebase Engine - v1.5.136

        Function refreshToken

        • refreshToken(refreshTokenPathOrObject, httpAgent?): Credential

        • Returns a credential created from the provided refresh token that grants +refreshToken | Firebase Engine - v1.5.137

          Function refreshToken

          • refreshToken(refreshTokenPathOrObject, httpAgent?): Credential

          • Returns a credential created from the provided refresh token that grants admin access to Firebase services. This credential can be used in the call to firebase-admin.app#initializeApp.

            See @@ -13,7 +13,7 @@ provided service account that can be used to initialize an app.

            Example

            // Providing a path to a refresh token JSON file
            var refreshToken = require("path/to/refreshToken.json");
            admin.initializeApp({
              credential: admin.credential.refreshToken(refreshToken),
              databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
            });
            -

          Settings

          Member Visibility

          Theme

          \ No newline at end of file diff --git a/docs/functions/utils_FirebaseAdmin.initializeApp.html b/docs/functions/utils_FirebaseAdmin.initializeApp.html index 70bb6f06..d223403d 100644 --- a/docs/functions/utils_FirebaseAdmin.initializeApp.html +++ b/docs/functions/utils_FirebaseAdmin.initializeApp.html @@ -1,4 +1,4 @@ -initializeApp | Firebase Engine - v1.5.136

          Function initializeApp

          • initializeApp(options?, appName?): App

          • Parameters

            • Optional options: AppOptions
            • Optional appName: string

            Returns App

          Settings

          Member Visibility

          Theme

          Function initializeApp

          • initializeApp(options?, appName?): App

          • Parameters

            • Optional options: AppOptions
            • Optional appName: string

            Returns App

          Settings

          Member Visibility

          Theme

          \ No newline at end of file diff --git a/docs/functions/utils_FirebaseAuth.getAuth.html b/docs/functions/utils_FirebaseAuth.getAuth.html index f53a462e..7368358f 100644 --- a/docs/functions/utils_FirebaseAuth.getAuth.html +++ b/docs/functions/utils_FirebaseAuth.getAuth.html @@ -1,4 +1,4 @@ -getAuth | Firebase Engine - v1.5.136

          Function getAuth

          • getAuth(app?): Auth

          • Gets the Auth service for the default app or a +getAuth | Firebase Engine - v1.5.137

            Function getAuth

            • getAuth(app?): Auth

            • Gets the Auth service for the default app or a given app.

              getAuth() can be called with no arguments to access the default app's Auth service or as getAuth(app) to access the @@ -7,7 +7,7 @@

              Example

              // Get the Auth service for a given app
              const otherAuth = getAuth(otherApp);
              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/functions/utils_FirebaseFirestore.getFirestore.html b/docs/functions/utils_FirebaseFirestore.getFirestore.html index 69c8d7ca..9a76b4c4 100644 --- a/docs/functions/utils_FirebaseFirestore.getFirestore.html +++ b/docs/functions/utils_FirebaseFirestore.getFirestore.html @@ -1,4 +1,4 @@ -getFirestore | Firebase Engine - v1.5.136

            Function getFirestore

            • getFirestore(): Firestore

            • Gets the default Firestore +getFirestore | Firebase Engine - v1.5.137

              Function getFirestore

              • getFirestore(): Firestore

              • Gets the default Firestore service for the default app.

                Returns Firestore

                The default Firestore service for the default app.

                @@ -26,7 +26,7 @@ service associated with the provided app.

                Example

                // Get the Firestore service for a named database and specific app.
                const otherFirestore = getFirestore('otherDb');
                -

              Settings

              Member Visibility

              Theme

              \ No newline at end of file diff --git a/docs/functions/utils_FirebaseStorage.getStorage.html b/docs/functions/utils_FirebaseStorage.getStorage.html index 4d78e41a..2075e209 100644 --- a/docs/functions/utils_FirebaseStorage.getStorage.html +++ b/docs/functions/utils_FirebaseStorage.getStorage.html @@ -1,4 +1,4 @@ -getStorage | Firebase Engine - v1.5.136

              Function getStorage

              • getStorage(app?): Storage

              • Gets the Storage service for the default app or a given app.

                +getStorage | Firebase Engine - v1.5.137

                Function getStorage

                • getStorage(app?): Storage

                • Gets the Storage service for the default app or a given app.

                  getStorage() can be called with no arguments to access the default app's Storage service or as getStorage(app) to access the Storage service associated with a specific app.

                  @@ -6,7 +6,7 @@

                  Example

                  // Get the Storage service for a given app
                  const otherStorage = getStorage(otherApp);
                  -

                Settings

                Member Visibility

                Theme

                \ No newline at end of file diff --git a/docs/functions/utils_initialization.cmdParser.html b/docs/functions/utils_initialization.cmdParser.html index 74635671..059274d5 100644 --- a/docs/functions/utils_initialization.cmdParser.html +++ b/docs/functions/utils_initialization.cmdParser.html @@ -1,5 +1,5 @@ -cmdParser | Firebase Engine - v1.5.136

                Function cmdParser

                Settings

                Member Visibility

                Theme

                Function cmdParser

                Settings

                Member Visibility

                Theme

                \ No newline at end of file diff --git a/docs/functions/utils_initialization.createWriteFileStream.html b/docs/functions/utils_initialization.createWriteFileStream.html index 9d6362cf..97802e7a 100644 --- a/docs/functions/utils_initialization.createWriteFileStream.html +++ b/docs/functions/utils_initialization.createWriteFileStream.html @@ -1,6 +1,6 @@ -createWriteFileStream | Firebase Engine - v1.5.136

                Function createWriteFileStream

                • createWriteFileStream(path, compress): Writer

                • Create write stream

                  +createWriteFileStream | Firebase Engine - v1.5.137

                  Function createWriteFileStream

                  Settings

                  Member Visibility

                  Theme

                  \ No newline at end of file diff --git a/docs/functions/utils_initialization.initialization.html b/docs/functions/utils_initialization.initialization.html index dfa163ca..2b0e44d4 100644 --- a/docs/functions/utils_initialization.initialization.html +++ b/docs/functions/utils_initialization.initialization.html @@ -1,6 +1,6 @@ -initialization | Firebase Engine - v1.5.136

                  Function initialization

                  • initialization(settings?): {
                        admin: App;
                        settings: Settings;
                        store: Storage;
                    }

                  • App initialization

                    +initialization | Firebase Engine - v1.5.137

                    Function initialization

                    Settings

                    Member Visibility

                    Theme

                    \ No newline at end of file diff --git a/docs/functions/utils_randomStr.randomStr.html b/docs/functions/utils_randomStr.randomStr.html index d01fc7c6..86faad07 100644 --- a/docs/functions/utils_randomStr.randomStr.html +++ b/docs/functions/utils_randomStr.randomStr.html @@ -1,6 +1,6 @@ -randomStr | Firebase Engine - v1.5.136

                    Function randomStr

                    • randomStr(length): string

                    • Random byte string like /0-9a-zA-Z/

                      +randomStr | Firebase Engine - v1.5.137

                      Function randomStr

                      • randomStr(length): string

                      • Random byte string like /0-9a-zA-Z/

                        Parameters

                        • length: number

                          code length

                          -

                        Returns string

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/hierarchy.html b/docs/hierarchy.html index ab1403e9..7806ce28 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1,4 +1,4 @@ -Firebase Engine - v1.5.136

                      Firebase Engine - v1.5.136

                      Class Hierarchy

                      Settings

                      Member Visibility

                      Theme

                      Firebase Engine - v1.5.137

                      Class Hierarchy

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index c2e5635f..4cc251dc 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -Firebase Engine - v1.5.136

                      Firebase Engine - v1.5.136

                      firebase-engine

                      Unlock Peak Performance for Your Firebase Project: A Dynamic Engine for Effortless Backup, Thorough Cleaning, and Seamless Restoration. Tailored for Firebase Firestore, Firebase Storage, and Firebase Auth. Streamline Your Workflow with Unrivaled Efficiency!

                      +Firebase Engine - v1.5.137

                      Firebase Engine - v1.5.137

                      firebase-engine

                      Unlock Peak Performance for Your Firebase Project: A Dynamic Engine for Effortless Backup, Thorough Cleaning, and Seamless Restoration. Tailored for Firebase Firestore, Firebase Storage, and Firebase Auth. Streamline Your Workflow with Unrivaled Efficiency!

                      npm npm NpmLicense @@ -150,7 +150,7 @@ 

                       firebase firestore:delete -r

                      LICENSE

                      Apache-2.0

                      -

                      Settings

                      Member Visibility

                      Theme

                      On This Page

                      firebase-engine
                      \ No newline at end of file diff --git a/docs/interfaces/utils_FirebaseAdmin.App.html b/docs/interfaces/utils_FirebaseAdmin.App.html index af6841c4..656233b6 100644 --- a/docs/interfaces/utils_FirebaseAdmin.App.html +++ b/docs/interfaces/utils_FirebaseAdmin.App.html @@ -1,4 +1,4 @@ -App | Firebase Engine - v1.5.136

                      Interface App

                      A Firebase app holds the initialization information for a collection of +App | Firebase Engine - v1.5.137

                      Interface App

                      A Firebase app holds the initialization information for a collection of services.

                      interface App {
                          name: string;
                          options: AppOptions;
                      }

                      Properties

                      name options @@ -12,7 +12,7 @@

                      Example

                      // A n
 parameters given in firebase-admin.app#initializeApp.

                      Example

                      const app = initializeApp(config);
                      console.log(app.options.credential === config.credential);  // true
                      console.log(app.options.databaseURL === config.databaseURL);  // true
                      -

                      Settings

                      Member Visibility

                      Theme

                      On This Page

                      nameoptions
                      \ No newline at end of file diff --git a/docs/interfaces/utils_initialization.ParsedSettings.html b/docs/interfaces/utils_initialization.ParsedSettings.html index 2a163a9e..66008ee1 100644 --- a/docs/interfaces/utils_initialization.ParsedSettings.html +++ b/docs/interfaces/utils_initialization.ParsedSettings.html @@ -1,5 +1,5 @@ -ParsedSettings | Firebase Engine - v1.5.136

                      Interface ParsedSettings

                      settings object from command line interface

                      -
                      interface ParsedSettings {
                          backup?: string;
                          buckets: string[];
                          collections: string[];
                          compress: boolean;
                          emulators: boolean;
                          hash_config: {
                              algorithm?: HashAlgorithmType;
                              base64_salt_separator?: Buffer;
                              base64_signer_key?: Buffer;
                              mem_cost?: number;
                              rounds?: number;
                          };
                          operations: ("backup" | "clean" | "restore")[];
                          path?: string;
                          services: ("auth" | "firestore" | "storage")[];
                      }

                      Properties

                      backup? +ParsedSettings | Firebase Engine - v1.5.137

                      Interface ParsedSettings

                      settings object from command line interface

                      +
                      interface ParsedSettings {
                          backup?: string;
                          buckets: string[];
                          collections: string[];
                          compress: boolean;
                          emulators: boolean;
                          hash_config: {
                              algorithm?: HashAlgorithmType;
                              base64_salt_separator?: Buffer;
                              base64_signer_key?: Buffer;
                              mem_cost?: number;
                              rounds?: number;
                          };
                          operations: ("backup" | "clean" | "restore")[];
                          path?: string;
                          services: ("auth" | "firestore" | "storage")[];
                      }

                      Properties

                      backup? buckets collections compress @@ -9,15 +9,15 @@ path? services

                      Properties

                      Optional backup

                      backup?: string

                      path to backup file

                      -

                      buckets

                      buckets: string[]

                      buckets for processing

                      -

                      collections

                      collections: string[]

                      collections for processing

                      -

                      compress

                      compress: boolean

                      use compress

                      -

                      emulators

                      emulators: boolean

                      use emulators

                      -

                      hash_config

                      hash_config: {
                          algorithm?: HashAlgorithmType;
                          base64_salt_separator?: Buffer;
                          base64_signer_key?: Buffer;
                          mem_cost?: number;
                          rounds?: number;
                      }

                      password hash config

                      -

                      Type declaration

                      • Optional algorithm?: HashAlgorithmType
                      • Optional base64_salt_separator?: Buffer
                      • Optional base64_signer_key?: Buffer
                      • Optional mem_cost?: number
                      • Optional rounds?: number

                      operations

                      operations: ("backup" | "clean" | "restore")[]

                      array of operations

                      -

                      Optional path

                      path?: string

                      path to Firebase service account key (json)

                      -

                      services

                      services: ("auth" | "firestore" | "storage")[]

                      service for backup/clean/restore

                      -

                      Settings

                      Member Visibility

                      Theme

                      On This Page

                      backupbucketscollectionscompressemulatorshash_configoperationspathservices
                      \ No newline at end of file diff --git a/docs/interfaces/utils_initialization.Settings.html b/docs/interfaces/utils_initialization.Settings.html index f1a80bab..7f5b1d6b 100644 --- a/docs/interfaces/utils_initialization.Settings.html +++ b/docs/interfaces/utils_initialization.Settings.html @@ -1,5 +1,5 @@ -Settings | Firebase Engine - v1.5.136

                      Interface Settings

                      settings object after initialization

                      -
                      interface Settings {
                          backup: string;
                          buckets: string[];
                          collections: string[];
                          compress: boolean;
                          emulators: boolean;
                          hash_config?: {
                              algorithm: HashAlgorithmType;
                              key: Buffer;
                              memoryCost: number;
                              rounds: number;
                              saltSeparator: Buffer;
                          };
                          path: string;
                          serviceAccount: {
                              [key: string]: any;
                          };
                      }

                      Properties

                      backup +Settings | Firebase Engine - v1.5.137

                      Interface Settings

                      settings object after initialization

                      +
                      interface Settings {
                          backup: string;
                          buckets: string[];
                          collections: string[];
                          compress: boolean;
                          emulators: boolean;
                          hash_config?: {
                              algorithm: HashAlgorithmType;
                              key: Buffer;
                              memoryCost: number;
                              rounds: number;
                              saltSeparator: Buffer;
                          };
                          path: string;
                          serviceAccount: {
                              [key: string]: any;
                          };
                      }

                      Properties

                      backup buckets collections compress @@ -8,14 +8,14 @@ path serviceAccount

                      Properties

                      backup

                      backup: string

                      path to backup file

                      -

                      buckets

                      buckets: string[]

                      buckets for processing

                      -

                      collections

                      collections: string[]

                      collections for processing

                      -

                      compress

                      compress: boolean

                      use compress

                      -

                      emulators

                      emulators: boolean

                      use emulators

                      -

                      Optional hash_config

                      hash_config?: {
                          algorithm: HashAlgorithmType;
                          key: Buffer;
                          memoryCost: number;
                          rounds: number;
                          saltSeparator: Buffer;
                      }

                      password hash config

                      -

                      Type declaration

                      • algorithm: HashAlgorithmType
                      • key: Buffer
                      • memoryCost: number
                      • rounds: number
                      • saltSeparator: Buffer

                      path

                      path: string

                      path to Firebase service account key (json)

                      -

                      serviceAccount

                      serviceAccount: {
                          [key: string]: any;
                      }

                      Firebase service account key (object)

                      -

                      Type declaration

                      • [key: string]: any

                      Settings

                      Member Visibility

                      Theme

                      On This Page

                      backupbucketscollectionscompressemulatorshash_configpathserviceAccount
                      \ No newline at end of file diff --git a/docs/interfaces/utils_initialization.SettingsBeforeInitialization.html b/docs/interfaces/utils_initialization.SettingsBeforeInitialization.html index 9494f53f..ce25440c 100644 --- a/docs/interfaces/utils_initialization.SettingsBeforeInitialization.html +++ b/docs/interfaces/utils_initialization.SettingsBeforeInitialization.html @@ -1,5 +1,5 @@ -SettingsBeforeInitialization | Firebase Engine - v1.5.136

                      Interface SettingsBeforeInitialization

                      settings object before initialization

                      -
                      interface SettingsBeforeInitialization {
                          backup?: string;
                          buckets?: string[];
                          collections?: string[];
                          compress?: boolean;
                          emulators?: boolean;
                          hash_config?: {
                              algorithm?: HashAlgorithmType;
                              base64_salt_separator?: Buffer;
                              base64_signer_key?: Buffer;
                              mem_cost?: number;
                              rounds?: number;
                          };
                          path?: string;
                      }

                      Properties

                      backup? +SettingsBeforeInitialization | Firebase Engine - v1.5.137

                      Interface SettingsBeforeInitialization

                      settings object before initialization

                      +
                      interface SettingsBeforeInitialization {
                          backup?: string;
                          buckets?: string[];
                          collections?: string[];
                          compress?: boolean;
                          emulators?: boolean;
                          hash_config?: {
                              algorithm?: HashAlgorithmType;
                              base64_salt_separator?: Buffer;
                              base64_signer_key?: Buffer;
                              mem_cost?: number;
                              rounds?: number;
                          };
                          path?: string;
                      }

                      Properties

                      backup? buckets? collections? compress? @@ -7,13 +7,13 @@ hash_config? path?

                      Properties

                      Optional backup

                      backup?: string

                      path to backup file

                      -

                      Optional buckets

                      buckets?: string[]

                      buckets for processing

                      -

                      Optional collections

                      collections?: string[]

                      collections for processing

                      -

                      Optional compress

                      compress?: boolean

                      use compress

                      -

                      Optional emulators

                      emulators?: boolean

                      use emulators

                      -

                      Optional hash_config

                      hash_config?: {
                          algorithm?: HashAlgorithmType;
                          base64_salt_separator?: Buffer;
                          base64_signer_key?: Buffer;
                          mem_cost?: number;
                          rounds?: number;
                      }

                      password hash config

                      -

                      Type declaration

                      • Optional algorithm?: HashAlgorithmType
                      • Optional base64_salt_separator?: Buffer
                      • Optional base64_signer_key?: Buffer
                      • Optional mem_cost?: number
                      • Optional rounds?: number

                      Optional path

                      path?: string

                      path to Firebase service account key (json)

                      -

                      Settings

                      Member Visibility

                      Theme

                      On This Page

                      backupbucketscollectionscompressemulatorshash_configpath
                      \ No newline at end of file diff --git a/docs/interfaces/utils_template.DataModel.html b/docs/interfaces/utils_template.DataModel.html index b0420d15..2850e98c 100644 --- a/docs/interfaces/utils_template.DataModel.html +++ b/docs/interfaces/utils_template.DataModel.html @@ -1,11 +1,11 @@ -DataModel | Firebase Engine - v1.5.136

                      Interface DataModel

                      Data Model

                      -
                      interface DataModel {
                          data: string;
                          path: string;
                          service: "auth" | "firestore" | "storage";
                      }

                      Properties

                      data +DataModel | Firebase Engine - v1.5.137

                      Interface DataModel

                      Data Model

                      +
                      interface DataModel {
                          data: string;
                          path: string;
                          service: "auth" | "firestore" | "storage";
                      }

                      Properties

                      data path service

                      Properties

                      data

                      data: string

                      document data

                      -

                      path

                      path: string

                      document path

                      -

                      service

                      service: "auth" | "firestore" | "storage"

                      service type

                      -

                      Settings

                      Member Visibility

                      Theme

                      On This Page

                      datapathservice
                      \ No newline at end of file diff --git a/docs/modules/FirebaseEngine.html b/docs/modules/FirebaseEngine.html index de13bcbe..33173f80 100644 --- a/docs/modules/FirebaseEngine.html +++ b/docs/modules/FirebaseEngine.html @@ -1,5 +1,5 @@ -FirebaseEngine | Firebase Engine - v1.5.136

                      Module FirebaseEngine

                      Index

                      Classes

                      FirebaseEngine -

                      Settings

                      Member Visibility

                      Theme

                      Module FirebaseEngine

                      Index

                      Classes

                      FirebaseEngine +

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/modules/bin_firebase_engine.html b/docs/modules/bin_firebase_engine.html index 79134ad2..8ad1b296 100644 --- a/docs/modules/bin_firebase_engine.html +++ b/docs/modules/bin_firebase_engine.html @@ -1,4 +1,4 @@ -bin/firebase-engine | Firebase Engine - v1.5.136

                      Module bin/firebase-engine

                      Settings

                      Member Visibility

                      Theme

                      Module bin/firebase-engine

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/modules/bin_firebase_engine_emulators.html b/docs/modules/bin_firebase_engine_emulators.html index 22992c85..a72af2f6 100644 --- a/docs/modules/bin_firebase_engine_emulators.html +++ b/docs/modules/bin_firebase_engine_emulators.html @@ -1,4 +1,4 @@ -bin/firebase-engine-emulators | Firebase Engine - v1.5.136

                      Module bin/firebase-engine-emulators

                      Settings

                      Member Visibility

                      Theme

                      Module bin/firebase-engine-emulators

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/modules/index.html b/docs/modules/index.html index a13d841c..e79aa323 100644 --- a/docs/modules/index.html +++ b/docs/modules/index.html @@ -1,4 +1,4 @@ -index | Firebase Engine - v1.5.136

                      Module index

                      Settings

                      Member Visibility

                      Theme

                      Module index

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/modules/jobs_Jobs.html b/docs/modules/jobs_Jobs.html index 644a5e96..5ff851f6 100644 --- a/docs/modules/jobs_Jobs.html +++ b/docs/modules/jobs_Jobs.html @@ -1,5 +1,5 @@ -jobs/Jobs | Firebase Engine - v1.5.136

                      Module jobs/Jobs

                      Index

                      Classes

                      Jobs -

                      Settings

                      Member Visibility

                      Theme

                      Module jobs/Jobs

                      Index

                      Classes

                      Jobs +

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/modules/jobs_backup_auth.html b/docs/modules/jobs_backup_auth.html index 42ef363e..646d084b 100644 --- a/docs/modules/jobs_backup_auth.html +++ b/docs/modules/jobs_backup_auth.html @@ -1,5 +1,5 @@ -jobs/backup/auth | Firebase Engine - v1.5.136

                      Module jobs/backup/auth

                      Index

                      Classes

                      JobBackupAuth -

                      Settings

                      Member Visibility

                      Theme

                      Module jobs/backup/auth

                      Index

                      Classes

                      JobBackupAuth +

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/modules/jobs_backup_firestore.html b/docs/modules/jobs_backup_firestore.html index e992cf71..b618e70a 100644 --- a/docs/modules/jobs_backup_firestore.html +++ b/docs/modules/jobs_backup_firestore.html @@ -1,5 +1,5 @@ -jobs/backup/firestore | Firebase Engine - v1.5.136

                      Module jobs/backup/firestore

                      Index

                      Classes

                      JobBackupFirestore -

                      Settings

                      Member Visibility

                      Theme

                      Module jobs/backup/firestore

                      Index

                      Classes

                      JobBackupFirestore +

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/modules/jobs_backup_storage.html b/docs/modules/jobs_backup_storage.html index 1aeeb7b5..dbd73f91 100644 --- a/docs/modules/jobs_backup_storage.html +++ b/docs/modules/jobs_backup_storage.html @@ -1,5 +1,5 @@ -jobs/backup/storage | Firebase Engine - v1.5.136

                      Module jobs/backup/storage

                      Index

                      Classes

                      JobBackupStorage -

                      Settings

                      Member Visibility

                      Theme

                      Module jobs/backup/storage

                      Index

                      Classes

                      JobBackupStorage +

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/modules/jobs_clean_auth.html b/docs/modules/jobs_clean_auth.html index a1acb6ad..de905444 100644 --- a/docs/modules/jobs_clean_auth.html +++ b/docs/modules/jobs_clean_auth.html @@ -1,5 +1,5 @@ -jobs/clean/auth | Firebase Engine - v1.5.136

                      Module jobs/clean/auth

                      Index

                      Classes

                      JobCleanAuth -

                      Settings

                      Member Visibility

                      Theme

                      Module jobs/clean/auth

                      Index

                      Classes

                      JobCleanAuth +

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/modules/jobs_clean_firestore.html b/docs/modules/jobs_clean_firestore.html index 6faeec64..0b3bd3ee 100644 --- a/docs/modules/jobs_clean_firestore.html +++ b/docs/modules/jobs_clean_firestore.html @@ -1,5 +1,5 @@ -jobs/clean/firestore | Firebase Engine - v1.5.136

                      Module jobs/clean/firestore

                      Index

                      Classes

                      JobCleanFirestore -

                      Settings

                      Member Visibility

                      Theme

                      Module jobs/clean/firestore

                      Index

                      Classes

                      JobCleanFirestore +

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/modules/jobs_clean_storage.html b/docs/modules/jobs_clean_storage.html index fde707fd..c04e2ffa 100644 --- a/docs/modules/jobs_clean_storage.html +++ b/docs/modules/jobs_clean_storage.html @@ -1,5 +1,5 @@ -jobs/clean/storage | Firebase Engine - v1.5.136

                      Module jobs/clean/storage

                      Index

                      Classes

                      JobCleanStorage -

                      Settings

                      Member Visibility

                      Theme

                      Module jobs/clean/storage

                      Index

                      Classes

                      JobCleanStorage +

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/modules/jobs_restore_auth.html b/docs/modules/jobs_restore_auth.html index bd32ef92..e029750d 100644 --- a/docs/modules/jobs_restore_auth.html +++ b/docs/modules/jobs_restore_auth.html @@ -1,5 +1,5 @@ -jobs/restore/auth | Firebase Engine - v1.5.136

                      Module jobs/restore/auth

                      Index

                      Classes

                      JobRestoreAuth -

                      Settings

                      Member Visibility

                      Theme

                      Module jobs/restore/auth

                      Index

                      Classes

                      JobRestoreAuth +

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/modules/jobs_restore_firestore.html b/docs/modules/jobs_restore_firestore.html index 124cad1f..a09dedd2 100644 --- a/docs/modules/jobs_restore_firestore.html +++ b/docs/modules/jobs_restore_firestore.html @@ -1,5 +1,5 @@ -jobs/restore/firestore | Firebase Engine - v1.5.136

                      Module jobs/restore/firestore

                      Index

                      Classes

                      JobRestoreFirestore -

                      Settings

                      Member Visibility

                      Theme

                      Module jobs/restore/firestore

                      Index

                      Classes

                      JobRestoreFirestore +

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/modules/jobs_restore_storage.html b/docs/modules/jobs_restore_storage.html index 6ee6b2c0..435d18a0 100644 --- a/docs/modules/jobs_restore_storage.html +++ b/docs/modules/jobs_restore_storage.html @@ -1,5 +1,5 @@ -jobs/restore/storage | Firebase Engine - v1.5.136

                      Module jobs/restore/storage

                      Index

                      Classes

                      JobRestoreStorage -

                      Settings

                      Member Visibility

                      Theme

                      Module jobs/restore/storage

                      Index

                      Classes

                      JobRestoreStorage +

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/modules/utils_AuthConverter.html b/docs/modules/utils_AuthConverter.html index b4452e79..4083bb03 100644 --- a/docs/modules/utils_AuthConverter.html +++ b/docs/modules/utils_AuthConverter.html @@ -1,5 +1,5 @@ -utils/AuthConverter | Firebase Engine - v1.5.136

                      Module utils/AuthConverter

                      Index

                      Classes

                      AuthConverter -

                      Settings

                      Member Visibility

                      Theme

                      Module utils/AuthConverter

                      Index

                      Classes

                      AuthConverter +

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/modules/utils_FirebaseAdmin.credential.html b/docs/modules/utils_FirebaseAdmin.credential.html index a2a2abb3..1703c048 100644 --- a/docs/modules/utils_FirebaseAdmin.credential.html +++ b/docs/modules/utils_FirebaseAdmin.credential.html @@ -1,8 +1,8 @@ -credential | Firebase Engine - v1.5.136

                      Namespace credential

                      Index

                      Type Aliases

                      Credential +credential | Firebase Engine - v1.5.137

                      Namespace credential

                      Index

                      Type Aliases

                      Credential

                      Functions

                      applicationDefault cert refreshToken -

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/modules/utils_FirebaseAdmin.html b/docs/modules/utils_FirebaseAdmin.html index 47fc1883..c1590da1 100644 --- a/docs/modules/utils_FirebaseAdmin.html +++ b/docs/modules/utils_FirebaseAdmin.html @@ -1,8 +1,8 @@ -utils/FirebaseAdmin | Firebase Engine - v1.5.136

                      Module utils/FirebaseAdmin

                      Index

                      Namespaces

                      credential +utils/FirebaseAdmin | Firebase Engine - v1.5.137

                      Module utils/FirebaseAdmin

                      Index

                      Namespaces

                      credential

                      Interfaces

                      App

                      Variables

                      apps

                      Functions

                      initializeApp -

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/modules/utils_FirebaseAuth.html b/docs/modules/utils_FirebaseAuth.html index ac5d1b0c..9eec91e2 100644 --- a/docs/modules/utils_FirebaseAuth.html +++ b/docs/modules/utils_FirebaseAuth.html @@ -1,8 +1,8 @@ -utils/FirebaseAuth | Firebase Engine - v1.5.136

                      Module utils/FirebaseAuth

                      Index

                      Classes

                      Auth +utils/FirebaseAuth | Firebase Engine - v1.5.137

                      Module utils/FirebaseAuth

                      Index

                      Classes

                      Auth UserRecord

                      Type Aliases

                      HashAlgorithmType

                      Functions

                      getAuth -

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/modules/utils_FirebaseFirestore.html b/docs/modules/utils_FirebaseFirestore.html index 1e6f0cae..6490d4f5 100644 --- a/docs/modules/utils_FirebaseFirestore.html +++ b/docs/modules/utils_FirebaseFirestore.html @@ -1,11 +1,11 @@ -utils/FirebaseFirestore | Firebase Engine - v1.5.136

                      Module utils/FirebaseFirestore

                      Index

                      Classes

                      DocumentReference +utils/FirebaseFirestore | Firebase Engine - v1.5.137

                      Module utils/FirebaseFirestore

                      Index

                      Classes

                      DocumentReference Firestore GeoPoint Timestamp WriteBatch

                      Type Aliases

                      DocumentData

                      Functions

                      getFirestore -

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/modules/utils_FirebaseStorage.html b/docs/modules/utils_FirebaseStorage.html index cf17cef6..95b5f47a 100644 --- a/docs/modules/utils_FirebaseStorage.html +++ b/docs/modules/utils_FirebaseStorage.html @@ -1,6 +1,6 @@ -utils/FirebaseStorage | Firebase Engine - v1.5.136

                      Module utils/FirebaseStorage

                      Index

                      Classes

                      Storage +utils/FirebaseStorage | Firebase Engine - v1.5.137

                      Module utils/FirebaseStorage

                      Index

                      Classes

                      Storage

                      Functions

                      getStorage -

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/modules/utils_FirestoreConverter.html b/docs/modules/utils_FirestoreConverter.html index 916ab61b..0f31439d 100644 --- a/docs/modules/utils_FirestoreConverter.html +++ b/docs/modules/utils_FirestoreConverter.html @@ -1,5 +1,5 @@ -utils/FirestoreConverter | Firebase Engine - v1.5.136

                      Module utils/FirestoreConverter

                      Index

                      Classes

                      FirestoreConverter -

                      Settings

                      Member Visibility

                      Theme

                      Module utils/FirestoreConverter

                      Index

                      Classes

                      FirestoreConverter +

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/modules/utils_Logger.html b/docs/modules/utils_Logger.html index e0628667..5d994771 100644 --- a/docs/modules/utils_Logger.html +++ b/docs/modules/utils_Logger.html @@ -1,5 +1,5 @@ -utils/Logger | Firebase Engine - v1.5.136

                      Module utils/Logger

                      Index

                      Classes

                      Logger -

                      Settings

                      Member Visibility

                      Theme

                      Module utils/Logger

                      Index

                      Classes

                      Logger +

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/modules/utils_StorageConverter.html b/docs/modules/utils_StorageConverter.html index 1d2846f3..595c4adf 100644 --- a/docs/modules/utils_StorageConverter.html +++ b/docs/modules/utils_StorageConverter.html @@ -1,5 +1,5 @@ -utils/StorageConverter | Firebase Engine - v1.5.136

                      Module utils/StorageConverter

                      Index

                      Classes

                      StorageConverter -

                      Settings

                      Member Visibility

                      Theme

                      Module utils/StorageConverter

                      Index

                      Classes

                      StorageConverter +

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/modules/utils_initialization.html b/docs/modules/utils_initialization.html index 8fbd49d0..17d8843c 100644 --- a/docs/modules/utils_initialization.html +++ b/docs/modules/utils_initialization.html @@ -1,4 +1,4 @@ -utils/initialization | Firebase Engine - v1.5.136

                      Module utils/initialization

                      Index

                      Classes

                      Writer +utils/initialization | Firebase Engine - v1.5.137

                      Module utils/initialization

                      Index

                      Classes

                      Writer

                      Interfaces

                      ParsedSettings Settings SettingsBeforeInitialization @@ -6,7 +6,7 @@

                      Functions

                      cmdParser createWriteFileStream initialization -

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/modules/utils_randomStr.html b/docs/modules/utils_randomStr.html index 0684f041..d9a77bed 100644 --- a/docs/modules/utils_randomStr.html +++ b/docs/modules/utils_randomStr.html @@ -1,5 +1,5 @@ -utils/randomStr | Firebase Engine - v1.5.136

                      Module utils/randomStr

                      Index

                      Functions

                      randomStr -

                      Settings

                      Member Visibility

                      Theme

                      Module utils/randomStr

                      Index

                      Functions

                      randomStr +

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/modules/utils_template.html b/docs/modules/utils_template.html index 9c13cef5..82b795a1 100644 --- a/docs/modules/utils_template.html +++ b/docs/modules/utils_template.html @@ -1,10 +1,10 @@ -utils/template | Firebase Engine - v1.5.136

                      Module utils/template

                      Index

                      Classes

                      JobBackupServiceRestoreTemplate +utils/template | Firebase Engine - v1.5.137

                      Module utils/template

                      Index

                      Classes

                      JobBackupServiceRestoreTemplate JobBackupServiceTemplate JobOneServiceTemplate JobOneTemplate JobTemplate

                      Interfaces

                      DataModel -

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/types/utils_FirebaseAdmin.credential.Credential.html b/docs/types/utils_FirebaseAdmin.credential.Credential.html index 495e0dfc..d83632fc 100644 --- a/docs/types/utils_FirebaseAdmin.credential.Credential.html +++ b/docs/types/utils_FirebaseAdmin.credential.Credential.html @@ -1,8 +1,8 @@ -Credential | Firebase Engine - v1.5.136

                      Type alias Credential

                      Credential: TCredential

                      Interface that provides Google OAuth2 access tokens used to authenticate +Credential | Firebase Engine - v1.5.137

                      Type alias Credential

                      Credential: TCredential

                      Interface that provides Google OAuth2 access tokens used to authenticate with Firebase services.

                      In most cases, you will not need to implement this yourself and can instead use the default implementations provided by the admin.credential namespace.

                      -

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/types/utils_FirebaseAuth.HashAlgorithmType.html b/docs/types/utils_FirebaseAuth.HashAlgorithmType.html index 34609a8b..a5adb8e1 100644 --- a/docs/types/utils_FirebaseAuth.HashAlgorithmType.html +++ b/docs/types/utils_FirebaseAuth.HashAlgorithmType.html @@ -1,4 +1,4 @@ -HashAlgorithmType | Firebase Engine - v1.5.136

                      Type alias HashAlgorithmType

                      HashAlgorithmType: "SCRYPT" | "STANDARD_SCRYPT" | "HMAC_SHA512" | "HMAC_SHA256" | "HMAC_SHA1" | "HMAC_MD5" | "MD5" | "PBKDF_SHA1" | "BCRYPT" | "PBKDF2_SHA256" | "SHA512" | "SHA256" | "SHA1"

                      Settings

                      Member Visibility

                      Theme

                      Type alias HashAlgorithmType

                      HashAlgorithmType: "SCRYPT" | "STANDARD_SCRYPT" | "HMAC_SHA512" | "HMAC_SHA256" | "HMAC_SHA1" | "HMAC_MD5" | "MD5" | "PBKDF_SHA1" | "BCRYPT" | "PBKDF2_SHA256" | "SHA512" | "SHA256" | "SHA1"

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/types/utils_FirebaseFirestore.DocumentData.html b/docs/types/utils_FirebaseFirestore.DocumentData.html index f61f6d44..6809e9c4 100644 --- a/docs/types/utils_FirebaseFirestore.DocumentData.html +++ b/docs/types/utils_FirebaseFirestore.DocumentData.html @@ -1,6 +1,6 @@ -DocumentData | Firebase Engine - v1.5.136

                      Type alias DocumentData

                      DocumentData: {
                          [field: string]: DocumentFieldValue;
                      }

                      Document data (for use with DocumentReference.set()) consists of fields +DocumentData | Firebase Engine - v1.5.137

                      Type alias DocumentData

                      DocumentData: {
                          [field: string]: DocumentFieldValue;
                      }

                      Document data (for use with DocumentReference.set()) consists of fields mapped to values.

                      -

                      Type declaration

                      • [field: string]: DocumentFieldValue

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/variables/utils_FirebaseAdmin.apps.html b/docs/variables/utils_FirebaseAdmin.apps.html index 4704211e..07fa6355 100644 --- a/docs/variables/utils_FirebaseAdmin.apps.html +++ b/docs/variables/utils_FirebaseAdmin.apps.html @@ -1,4 +1,4 @@ -apps | Firebase Engine - v1.5.136

                      Variable appsConst

                      apps: (app.App | null)[]

                      Settings

                      Member Visibility

                      Theme

                      Variable appsConst

                      apps: (app.App | null)[]

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file diff --git a/docs/variables/utils_initialization.writers.html b/docs/variables/utils_initialization.writers.html index dff1e6b9..d4aa8480 100644 --- a/docs/variables/utils_initialization.writers.html +++ b/docs/variables/utils_initialization.writers.html @@ -1,5 +1,5 @@ -writers | Firebase Engine - v1.5.136

                      Variable writersConst

                      writers: {
                          [key: string]: Writer;
                      } = {}

                      write streams

                      -

                      Type declaration

                      Settings

                      Member Visibility

                      Theme

                      Variable writersConst

                      writers: {
                          [key: string]: Writer;
                      } = {}

                      write streams

                      +

                      Type declaration

                      Settings

                      Member Visibility

                      Theme

                      \ No newline at end of file