From 1d7ca95d380650c0b8bfa3f3a57b4ae2a8b25338 Mon Sep 17 00:00:00 2001 From: Siarhei Date: Tue, 31 Oct 2023 01:50:51 +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/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 +-- 77 files changed, 353 insertions(+), 353 deletions(-) diff --git a/docs/classes/FirebaseEngine.FirebaseEngine.html b/docs/classes/FirebaseEngine.FirebaseEngine.html index c6ed610c..13d1e39e 100644 --- a/docs/classes/FirebaseEngine.FirebaseEngine.html +++ b/docs/classes/FirebaseEngine.FirebaseEngine.html @@ -1,17 +1,17 @@ -FirebaseEngine | Firebase Engine - v1.5.101

Firebase Engine to copy data

-

Hierarchy

  • FirebaseEngine

Constructors

constructor +FirebaseEngine | Firebase Engine - v1.5.102

Firebase Engine to copy data

+

Hierarchy

  • FirebaseEngine

Constructors

Properties

Methods

Constructors

Properties

admin: App

firebase app

-
jobs: Jobs

Firebase Engine Jobs

-
settings: Settings

settings object

-
store: Storage

Google cloud storage app

-

Methods

\ No newline at end of file diff --git a/docs/classes/jobs_Jobs.Jobs.html b/docs/classes/jobs_Jobs.Jobs.html index 0ae369a8..456248ee 100644 --- a/docs/classes/jobs_Jobs.Jobs.html +++ b/docs/classes/jobs_Jobs.Jobs.html @@ -1,5 +1,5 @@ -Jobs | Firebase Engine - v1.5.101

Jobs Class

-

Hierarchy

Constructors

constructor +Jobs | Firebase Engine - v1.5.102

Jobs Class

+

Hierarchy

Constructors

Properties

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

Constructors

Properties

admin: App

firebase app

-
backup: JobsBackup

backup jobs

-
clean: JobsClean

clean jobs

-
restore: JobsRestore

restore jobs

-
settings: Settings

settings object

-
store: Storage

Google cloud storage app

-
\ 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 d39d265d..045f0cfc 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.101

Job backup

-

Hierarchy

Constructors

constructor +JobBackupAuth | Firebase Engine - v1.5.102

Job backup

+

Hierarchy

Constructors

Properties

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

Constructors

Properties

admin: App

firebase app

-
auth: Auth

firebase auth app

-
counter: number = 0

operation counter

-
settings: Settings

settings object

-
startTimestamp: number

start timestamp

-
store: Storage

Google cloud storage app

-
stringiferStream: Transform

object to string stream

-
writer: Writer

Writer streams in object

-

Methods

  • recursive backup function

    -

    Parameters

    • Optional nextPageToken: string

    Returns Promise<void>

\ 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 e333a1f5..91c0e6c5 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.101

Job backup

-

Hierarchy

Constructors

constructor +JobBackupFirestore | Firebase Engine - v1.5.102

Job backup

+

Hierarchy

Constructors

Properties

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

Constructors

Properties

admin: App

firebase app

-
counter: number = 0

operation counter

-
firestore: Firestore

firebase firestore app

-
settings: Settings

settings object

-
startTimestamp: number

start timestamp

-
store: Storage

Google cloud storage app

-
stringiferStream: Transform

object to string stream

-
writer: Writer

Writer streams in object

-

Methods

\ 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 e9bf6780..fde3915f 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.101

Job backup

-

Hierarchy

Constructors

constructor +JobBackupStorage | Firebase Engine - v1.5.102

Job backup

+

Hierarchy

Constructors

Properties

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

Constructors

Properties

admin: App

firebase app

-
counter: number = 0

operation counter

-
settings: Settings

settings object

-
startTimestamp: number

start timestamp

-
store: Storage

Google cloud storage app

-
stringiferStream: Transform

object to string stream

-
writer: Writer

Writer streams in object

-

Methods

  • backup one file function

    -

    Parameters

    • bucket: Bucket
    • file: File

    Returns Promise<void>

\ 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 3a5bb9a4..a87cce13 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.101

Job class

-

Hierarchy

Constructors

constructor +JobCleanAuth | Firebase Engine - v1.5.102

Job class

+

Hierarchy

Constructors

Properties

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

Constructors

Properties

admin: App

firebase app

-
auth: Auth

firebase auth app

-
counter: number = 0

operation counter

-
settings: Settings

settings object

-
startTimestamp: number

start timestamp

-
store: Storage

Google cloud storage app

-

Methods

  • recursive clean function

    -

    Parameters

    • Optional nextPageToken: string

    Returns Promise<void>

\ 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 5b7be9b8..7638dce7 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.101

Job class

-

Hierarchy

Constructors

constructor +JobCleanFirestore | Firebase Engine - v1.5.102

Job class

+

Hierarchy

Constructors

Properties

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

Constructors

Properties

admin: App

firebase app

-
batch: WriteBatch

batch object

-
counter: number = 0

operation counter

-
firestore: Firestore

firebase firestore app

-
settings: Settings

settings object

-
startTimestamp: number

start timestamp

-
store: Storage

Google cloud storage app

-
batchSize: number = 500

document on one batch

-

Methods

\ 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 51f908a8..d6111d19 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.101

Job class

-

Hierarchy

Constructors

constructor +JobCleanStorage | Firebase Engine - v1.5.102

Job class

+

Hierarchy

Constructors

Properties

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

Constructors

Properties

admin: App

firebase app

-
counter: number = 0

operation counter

-
settings: Settings

settings object

-
startTimestamp: number

start timestamp

-
store: Storage

Google cloud storage app

-

Methods

\ 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 20adad04..a3702fdc 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.101

Job restore

-

Hierarchy

Constructors

constructor +JobRestoreAuth | Firebase Engine - v1.5.102

Job restore

+

Hierarchy

Constructors

Properties

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

Constructors

Properties

admin: App

firebase app

-
auth: Auth

firebase auth app

-
counter: number = 0

operation counter

-
fileStream: ReadStream

file read stream

-
gunzipStream?: Gunzip

unzip stream

-
parserStream: Transform

string to object stream

-
settings: Settings

settings object

-
startTimestamp: number

start timestamp

-
store: Storage

Google cloud storage app

-
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: App

firebase app

+
auth: Auth

firebase auth app

+
counter: number = 0

operation counter

+
fileStream: ReadStream

file read stream

+
gunzipStream?: Gunzip

unzip stream

+
parserStream: Transform

string to object stream

+
settings: Settings

settings object

+
startTimestamp: number

start timestamp

+
store: Storage

Google cloud storage app

+
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

    -
writeStream: Writable

write user to project stream

-

Methods

\ 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 8e2393a7..535f3282 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.101

Job restore

-

Hierarchy

Constructors

constructor +JobRestoreFirestore | Firebase Engine - v1.5.102

Job restore

+

Hierarchy

Constructors

Properties

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

Constructors

Properties

admin: App

firebase app

-
counter: number = 0

operation counter

-
fileStream: ReadStream

file read stream

-
firestore: Firestore

firebase firestore app

-
gunzipStream?: Gunzip

unzip stream

-
parserStream: Transform

string to object stream

-
settings: Settings

settings object

-
startTimestamp: number

start timestamp

-
store: Storage

Google cloud storage app

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

buffer for write to project

+

Returns JobRestoreFirestore

Properties

admin: App

firebase app

+
counter: number = 0

operation counter

+
fileStream: ReadStream

file read stream

+
firestore: Firestore

firebase firestore app

+
gunzipStream?: Gunzip

unzip stream

+
parserStream: Transform

string to object stream

+
settings: Settings

settings object

+
startTimestamp: number

start timestamp

+
store: Storage

Google cloud storage app

+
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

    -
writeStream: Writable

write document to project stream

-

Methods

\ 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 deb08f39..d8188a55 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.101

Job restore

-

Hierarchy

Constructors

constructor +JobRestoreStorage | Firebase Engine - v1.5.102

Job restore

+

Hierarchy

Constructors

Properties

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

Constructors

Properties

admin: App

firebase app

-
buckets: string[]

Array of google storage bucket name

-
counter: number = 0

operation counter

-
fileStream: ReadStream

file read stream

-
gunzipStream?: Gunzip

unzip stream

-
parserStream: Transform

string to object stream

-
settings: Settings

settings object

-
startTimestamp: number

start timestamp

-
store: Storage

Google cloud storage app

-
writeStream: Writable

write file to project stream

-

Methods

\ No newline at end of file diff --git a/docs/classes/utils_AuthConverter.AuthConverter.html b/docs/classes/utils_AuthConverter.AuthConverter.html index 51e4c526..5ab6c9c1 100644 --- a/docs/classes/utils_AuthConverter.AuthConverter.html +++ b/docs/classes/utils_AuthConverter.AuthConverter.html @@ -1,16 +1,16 @@ -AuthConverter | Firebase Engine - v1.5.101

Auth Document converter

-

Hierarchy

  • AuthConverter

Constructors

constructor +AuthConverter | Firebase Engine - v1.5.102

Auth Document converter

+

Hierarchy

  • AuthConverter

Constructors

Properties

Methods

Constructors

Properties

userField: string[] = ...

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

-

Methods

  • Convert string to object

    +

Methods

  • Convert string to object

    Parameters

    • d: string

      String to convert

      -
    • restorePassword: boolean = false

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

    • [key: string]: any
    • uid: string
  • Convert an object to a string

    +
  • restorePassword: boolean = false

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

  • [key: string]: any
  • uid: string
\ No newline at end of file diff --git a/docs/classes/utils_FirebaseAuth.Auth.html b/docs/classes/utils_FirebaseAuth.Auth.html index 8bbc49d2..1e5f7be3 100644 --- a/docs/classes/utils_FirebaseAuth.Auth.html +++ b/docs/classes/utils_FirebaseAuth.Auth.html @@ -1,4 +1,4 @@ -Auth | Firebase Engine - v1.5.101

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

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

Hierarchy

  • BaseAuth
    • Auth

Constructors

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.

    -
    \ No newline at end of file diff --git a/docs/classes/utils_FirebaseAuth.UserRecord.html b/docs/classes/utils_FirebaseAuth.UserRecord.html index 766804c6..8a5f7553 100644 --- a/docs/classes/utils_FirebaseAuth.UserRecord.html +++ b/docs/classes/utils_FirebaseAuth.UserRecord.html @@ -1,4 +1,4 @@ -UserRecord | Firebase Engine - v1.5.101

    Represents a user.

    +UserRecord | Firebase Engine - v1.5.102

    Represents a user.

    Hierarchy

    • UserRecord

    Constructors

    Properties

    customClaims? disabled @@ -49,7 +49,7 @@
    uid: string

    The user's uid.

    Methods

    • Returns a JSON-serializable representation of this object.

      Returns object

      A JSON-serializable representation of this object.

      -
    \ No newline at end of file diff --git a/docs/classes/utils_FirebaseFirestore.DocumentReference.html b/docs/classes/utils_FirebaseFirestore.DocumentReference.html index 7de0efaf..0654715d 100644 --- a/docs/classes/utils_FirebaseFirestore.DocumentReference.html +++ b/docs/classes/utils_FirebaseFirestore.DocumentReference.html @@ -1,4 +1,4 @@ -DocumentReference | Firebase Engine - v1.5.101

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

    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.

    @@ -90,7 +90,7 @@

    Type Parameters

    • U

    Parameters

    • converter: FirestoreDataConverter<U>

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

    Returns DocumentReference<U>

    A DocumentReference that uses the provided converter.

    -
  • Parameters

    • converter: null

    Returns DocumentReference<DocumentData>

  • \ No newline at end of file diff --git a/docs/classes/utils_FirebaseFirestore.Firestore.html b/docs/classes/utils_FirebaseFirestore.Firestore.html index 3f596276..e69e9cbe 100644 --- a/docs/classes/utils_FirebaseFirestore.Firestore.html +++ b/docs/classes/utils_FirebaseFirestore.Firestore.html @@ -1,4 +1,4 @@ -Firestore | Firebase Engine - v1.5.101

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

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

    Hierarchy

    • Firestore

    Constructors

    Methods

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

    Returns void

    • Terminates the Firestore client and closes all open streams.

      Returns Promise<void>

      A Promise that resolves when the client is terminated.

      -
    \ No newline at end of file diff --git a/docs/classes/utils_FirebaseFirestore.GeoPoint.html b/docs/classes/utils_FirebaseFirestore.GeoPoint.html index 4114b664..a018f8f0 100644 --- a/docs/classes/utils_FirebaseFirestore.GeoPoint.html +++ b/docs/classes/utils_FirebaseFirestore.GeoPoint.html @@ -1,4 +1,4 @@ -GeoPoint | Firebase Engine - v1.5.101

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

    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

    latitude: number
    longitude: number

    Methods

    • 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.

      -
    \ No newline at end of file diff --git a/docs/classes/utils_FirebaseFirestore.Timestamp.html b/docs/classes/utils_FirebaseFirestore.Timestamp.html index 6d7ba109..3a44f300 100644 --- a/docs/classes/utils_FirebaseFirestore.Timestamp.html +++ b/docs/classes/utils_FirebaseFirestore.Timestamp.html @@ -1,4 +1,4 @@ -Timestamp | Firebase Engine - v1.5.101

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

    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.

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

      Returns Timestamp

      A new Timestamp representing the current date.

      -
    \ No newline at end of file diff --git a/docs/classes/utils_FirebaseFirestore.WriteBatch.html b/docs/classes/utils_FirebaseFirestore.WriteBatch.html index f7fb7ab6..5cef64f2 100644 --- a/docs/classes/utils_FirebaseFirestore.WriteBatch.html +++ b/docs/classes/utils_FirebaseFirestore.WriteBatch.html @@ -1,4 +1,4 @@ -WriteBatch | Firebase Engine - v1.5.101

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

    +WriteBatch | Firebase Engine - v1.5.102

    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.

    -
    \ No newline at end of file diff --git a/docs/classes/utils_FirebaseStorage.Storage.html b/docs/classes/utils_FirebaseStorage.Storage.html index 2337f5e7..c3c71a63 100644 --- a/docs/classes/utils_FirebaseStorage.Storage.html +++ b/docs/classes/utils_FirebaseStorage.Storage.html @@ -1,4 +1,4 @@ -Storage | Firebase Engine - v1.5.101

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

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

    Hierarchy

    • Storage

    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.

    -
    \ No newline at end of file diff --git a/docs/classes/utils_FirestoreConverter.FirestoreConverter.html b/docs/classes/utils_FirestoreConverter.FirestoreConverter.html index 1c4b33c5..e20f0e06 100644 --- a/docs/classes/utils_FirestoreConverter.FirestoreConverter.html +++ b/docs/classes/utils_FirestoreConverter.FirestoreConverter.html @@ -1,18 +1,18 @@ -FirestoreConverter | Firebase Engine - v1.5.101

    Firestore Document converter

    -

    Hierarchy

    • FirestoreConverter

    Constructors

    constructor +FirestoreConverter | Firebase Engine - v1.5.102

    Firestore Document converter

    +

    Hierarchy

    • FirestoreConverter

    Constructors

    Methods

    • Convert string to object

      +

    Returns any

    • Internal deserialization

      +

    Returns any

    • Internal deserialization

      Parameters

      • d: any

        Object for deserialization

        -

      Returns {
          data: any;
          type: string;
      }

      • data: any
      • type: string
    • Convert an object to a string

      +

    Returns {
        data: any;
        type: string;
    }

    • data: any
    • type: string
    • Convert an object to a string

      Parameters

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

        Object for convert

        -
        • [key: string]: any

      Returns string

    \ No newline at end of file diff --git a/docs/classes/utils_Logger.Logger.html b/docs/classes/utils_Logger.Logger.html index 7e9d2033..b3235aab 100644 --- a/docs/classes/utils_Logger.Logger.html +++ b/docs/classes/utils_Logger.Logger.html @@ -1,14 +1,14 @@ -Logger | Firebase Engine - v1.5.101

    Logger class

    -

    Hierarchy

    • Logger

    Constructors

    constructor +Logger | Firebase Engine - v1.5.102

    Logger class

    +

    Hierarchy

    • Logger

    Constructors

    Methods

    Constructors

    Methods

    \ No newline at end of file diff --git a/docs/classes/utils_StorageConverter.StorageConverter.html b/docs/classes/utils_StorageConverter.StorageConverter.html index 1d62d8f5..86d5c907 100644 --- a/docs/classes/utils_StorageConverter.StorageConverter.html +++ b/docs/classes/utils_StorageConverter.StorageConverter.html @@ -1,12 +1,12 @@ -StorageConverter | Firebase Engine - v1.5.101

    Storage File converter

    -

    Hierarchy

    • StorageConverter

    Constructors

    constructor +StorageConverter | Firebase Engine - v1.5.102

    Storage File converter

    +

    Hierarchy

    • StorageConverter

    Constructors

    Methods

    Constructors

    Methods

    • Convert an object to a string

      +

    Returns Buffer

    \ No newline at end of file diff --git a/docs/classes/utils_initialization.Writer.html b/docs/classes/utils_initialization.Writer.html index f0182b4a..5ca0a7c2 100644 --- a/docs/classes/utils_initialization.Writer.html +++ b/docs/classes/utils_initialization.Writer.html @@ -1,13 +1,13 @@ -Writer | Firebase Engine - v1.5.101

    Writer Class for create write streams

    -

    Hierarchy

    • Writer

    Constructors

    constructor +Writer | Firebase Engine - v1.5.102

    Writer Class for create write streams

    +

    Hierarchy

    • Writer

    Constructors

    Properties

    compress: boolean = false

    use compress

    -
    fileStream: WriteStream

    file write stream after gzipped

    -
    gzipStream?: Gzip

    gzip stream

    -
    \ No newline at end of file diff --git a/docs/classes/utils_template.JobBackupServiceRestoreTemplate.html b/docs/classes/utils_template.JobBackupServiceRestoreTemplate.html index e136ef28..2b048580 100644 --- a/docs/classes/utils_template.JobBackupServiceRestoreTemplate.html +++ b/docs/classes/utils_template.JobBackupServiceRestoreTemplate.html @@ -1,5 +1,5 @@ -JobBackupServiceRestoreTemplate | Firebase Engine - v1.5.101

    Job restore

    -

    Hierarchy

    Constructors

    constructor +JobBackupServiceRestoreTemplate | Firebase Engine - v1.5.102

    Job restore

    +

    Hierarchy

    Constructors

    Properties

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

    Constructors

    Properties

    admin: App

    firebase app

    -
    counter: number = 0

    operation counter

    -
    fileStream: ReadStream

    file read stream

    -
    gunzipStream?: Gunzip

    unzip stream

    -
    parserStream: Transform

    string to object stream

    -
    settings: Settings

    settings object

    -
    startTimestamp: number

    start timestamp

    -
    store: Storage

    Google cloud storage app

    -

    Methods

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

    Job backup

    -

    Hierarchy

    Constructors

    constructor +JobBackupServiceTemplate | Firebase Engine - v1.5.102

    Job backup

    +

    Hierarchy

    Constructors

    Properties

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

    Constructors

    Properties

    admin: App

    firebase app

    -
    counter: number = 0

    operation counter

    -
    settings: Settings

    settings object

    -
    startTimestamp: number

    start timestamp

    -
    store: Storage

    Google cloud storage app

    -
    stringiferStream: Transform

    object to string stream

    -
    writer: Writer

    Writer streams in object

    -

    Methods

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

    Job class

    -

    Hierarchy

    Constructors

    constructor +JobOneServiceTemplate | Firebase Engine - v1.5.102

    Job class

    +

    Hierarchy

    Constructors

    Properties

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

    Constructors

    Properties

    admin: App

    firebase app

    -
    counter: number = 0

    operation counter

    -
    settings: Settings

    settings object

    -
    startTimestamp: number

    start timestamp

    -
    store: Storage

    Google cloud storage app

    -

    Methods

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

    Job One Template Class

    -

    Hierarchy

    Constructors

    constructor +JobOneTemplate | Firebase Engine - v1.5.102

    Job One Template Class

    +

    Hierarchy

    Constructors

    Properties

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

    Constructors

    Properties

    admin: App

    firebase app

    -
    settings: Settings

    settings object

    -
    store: Storage

    Google cloud storage app

    -

    Methods

    \ No newline at end of file diff --git a/docs/classes/utils_template.JobTemplate.html b/docs/classes/utils_template.JobTemplate.html index 2c3d128f..c0cc80b9 100644 --- a/docs/classes/utils_template.JobTemplate.html +++ b/docs/classes/utils_template.JobTemplate.html @@ -1,15 +1,15 @@ -JobTemplate | Firebase Engine - v1.5.101

    Job Template Class

    -

    Hierarchy

    Constructors

    constructor +JobTemplate | Firebase Engine - v1.5.102

    Job Template Class

    +

    Hierarchy

    Constructors

    Properties

    Constructors

    Properties

    admin: App

    firebase app

    -
    settings: Settings

    settings object

    -
    store: Storage

    Google cloud storage app

    -
    \ 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 61c4a30f..02d3eae1 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.101
    • Returns a credential created from the +applicationDefault | Firebase Engine - v1.5.102

      • 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"
        });
        -
      \ 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 1e3e1936..e203aa37 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.101
      • Returns a credential created from the provided service account that grants +cert | Firebase Engine - v1.5.102

        • 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"
          });
          -
        \ 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 f455273a..c566335c 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.101
        • Returns a credential created from the provided refresh token that grants +refreshToken | Firebase Engine - v1.5.102

          • 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"
            });
            -
          \ No newline at end of file diff --git a/docs/functions/utils_FirebaseAdmin.initializeApp.html b/docs/functions/utils_FirebaseAdmin.initializeApp.html index 0f9bafa4..07e35d1e 100644 --- a/docs/functions/utils_FirebaseAdmin.initializeApp.html +++ b/docs/functions/utils_FirebaseAdmin.initializeApp.html @@ -1,4 +1,4 @@ -initializeApp | Firebase Engine - v1.5.101
          \ No newline at end of file diff --git a/docs/functions/utils_FirebaseAuth.getAuth.html b/docs/functions/utils_FirebaseAuth.getAuth.html index 67b97a89..3226c2ae 100644 --- a/docs/functions/utils_FirebaseAuth.getAuth.html +++ b/docs/functions/utils_FirebaseAuth.getAuth.html @@ -1,4 +1,4 @@ -getAuth | Firebase Engine - v1.5.101
          • Gets the Auth service for the default app or a +getAuth | Firebase Engine - v1.5.102

            • 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);
              -
            \ No newline at end of file diff --git a/docs/functions/utils_FirebaseFirestore.getFirestore.html b/docs/functions/utils_FirebaseFirestore.getFirestore.html index 43296fe8..f38a28dd 100644 --- a/docs/functions/utils_FirebaseFirestore.getFirestore.html +++ b/docs/functions/utils_FirebaseFirestore.getFirestore.html @@ -1,4 +1,4 @@ -getFirestore | Firebase Engine - v1.5.101
            • Gets the default Firestore +getFirestore | Firebase Engine - v1.5.102

              • 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');
                -
              \ No newline at end of file diff --git a/docs/functions/utils_FirebaseStorage.getStorage.html b/docs/functions/utils_FirebaseStorage.getStorage.html index 58df527b..c886ba2c 100644 --- a/docs/functions/utils_FirebaseStorage.getStorage.html +++ b/docs/functions/utils_FirebaseStorage.getStorage.html @@ -1,4 +1,4 @@ -getStorage | Firebase Engine - v1.5.101
              • Gets the Storage service for the default app or a given app.

                +getStorage | Firebase Engine - v1.5.102
                • 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);
                  -
                \ No newline at end of file diff --git a/docs/functions/utils_initialization.cmdParser.html b/docs/functions/utils_initialization.cmdParser.html index 08f73bb8..46e90f08 100644 --- a/docs/functions/utils_initialization.cmdParser.html +++ b/docs/functions/utils_initialization.cmdParser.html @@ -1,5 +1,5 @@ -cmdParser | Firebase Engine - v1.5.101
                \ No newline at end of file diff --git a/docs/functions/utils_initialization.createWriteFileStream.html b/docs/functions/utils_initialization.createWriteFileStream.html index ff2be9fe..6f3e9105 100644 --- a/docs/functions/utils_initialization.createWriteFileStream.html +++ b/docs/functions/utils_initialization.createWriteFileStream.html @@ -1,6 +1,6 @@ -createWriteFileStream | Firebase Engine - v1.5.101
                • Create write stream

                  +createWriteFileStream | Firebase Engine - v1.5.102
                  \ No newline at end of file diff --git a/docs/functions/utils_initialization.initialization.html b/docs/functions/utils_initialization.initialization.html index c19d938b..bcd71c13 100644 --- a/docs/functions/utils_initialization.initialization.html +++ b/docs/functions/utils_initialization.initialization.html @@ -1,6 +1,6 @@ -initialization | Firebase Engine - v1.5.101
                  • App initialization

                    +initialization | Firebase Engine - v1.5.102
                    \ No newline at end of file diff --git a/docs/functions/utils_randomStr.randomStr.html b/docs/functions/utils_randomStr.randomStr.html index 71c414c9..701bd2e1 100644 --- a/docs/functions/utils_randomStr.randomStr.html +++ b/docs/functions/utils_randomStr.randomStr.html @@ -1,6 +1,6 @@ -randomStr | Firebase Engine - v1.5.101
                    • Random byte string like /0-9a-zA-Z/

                      +randomStr | Firebase Engine - v1.5.102
                      \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 8108dadb..aa48e430 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -Firebase Engine - v1.5.101

                      Firebase Engine - v1.5.101

                      firebase-engine

                      Engine to Backup, Clean, Restore. Work for Firebase.Firestore, Firebase.Storage, Firebase.Auth

                      +Firebase Engine - v1.5.102
                      \ No newline at end of file diff --git a/docs/interfaces/utils_FirebaseAdmin.App.html b/docs/interfaces/utils_FirebaseAdmin.App.html index 3c7c9c62..05903626 100644 --- a/docs/interfaces/utils_FirebaseAdmin.App.html +++ b/docs/interfaces/utils_FirebaseAdmin.App.html @@ -1,4 +1,4 @@ -App | Firebase Engine - v1.5.101

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

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

                      Hierarchy

                      • App

                      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
                      -
                      \ No newline at end of file diff --git a/docs/interfaces/utils_initialization.ParsedSettings.html b/docs/interfaces/utils_initialization.ParsedSettings.html index 2277d505..5f987b2d 100644 --- a/docs/interfaces/utils_initialization.ParsedSettings.html +++ b/docs/interfaces/utils_initialization.ParsedSettings.html @@ -1,5 +1,5 @@ -ParsedSettings | Firebase Engine - v1.5.101

                      settings object from command line interface

                      -

                      Hierarchy

                      • ParsedSettings

                      Properties

                      backup? +ParsedSettings | Firebase Engine - v1.5.102

                      settings object from command line interface

                      +

                      Hierarchy

                      • ParsedSettings

                      Properties

                      Properties

                      backup?: string

                      path to backup file

                      -
                      buckets: string[]

                      buckets for processing

                      -
                      collections: string[]

                      collections for processing

                      -
                      compress: boolean

                      use compress

                      -
                      emulators: boolean

                      use emulators

                      -
                      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: ("backup" | "clean" | "restore")[]

                      array of operations

                      -
                      path?: string

                      path to Firebase service account key (json)

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

                      service for backup/clean/restore

                      -
                      \ No newline at end of file diff --git a/docs/interfaces/utils_initialization.Settings.html b/docs/interfaces/utils_initialization.Settings.html index f943fe05..4131e975 100644 --- a/docs/interfaces/utils_initialization.Settings.html +++ b/docs/interfaces/utils_initialization.Settings.html @@ -1,5 +1,5 @@ -Settings | Firebase Engine - v1.5.101

                      settings object after initialization

                      -

                      Hierarchy

                      • Settings

                      Properties

                      backup +Settings | Firebase Engine - v1.5.102

                      settings object after initialization

                      +

                      Hierarchy

                      • Settings

                      Properties

                      Properties

                      backup: string

                      path to backup file

                      -
                      buckets: string[]

                      buckets for processing

                      -
                      collections: string[]

                      collections for processing

                      -
                      compress: boolean

                      use compress

                      -
                      emulators: boolean

                      use emulators

                      -
                      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: string

                      path to Firebase service account key (json)

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

                      Firebase service account key (object)

                      -

                      Type declaration

                      • [key: string]: any
                      \ No newline at end of file diff --git a/docs/interfaces/utils_initialization.SettingsBeforeInitialization.html b/docs/interfaces/utils_initialization.SettingsBeforeInitialization.html index 2be8996d..4848d81f 100644 --- a/docs/interfaces/utils_initialization.SettingsBeforeInitialization.html +++ b/docs/interfaces/utils_initialization.SettingsBeforeInitialization.html @@ -1,5 +1,5 @@ -SettingsBeforeInitialization | Firebase Engine - v1.5.101

                      settings object before initialization

                      -

                      Hierarchy

                      • SettingsBeforeInitialization

                      Properties

                      backup? +SettingsBeforeInitialization | Firebase Engine - v1.5.102

                      settings object before initialization

                      +

                      Hierarchy

                      • SettingsBeforeInitialization

                      Properties

                      backup?: string

                      path to backup file

                      -
                      buckets?: string[]

                      buckets for processing

                      -
                      collections?: string[]

                      collections for processing

                      -
                      compress?: boolean

                      use compress

                      -
                      emulators?: boolean

                      use emulators

                      -
                      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
                      path?: string

                      path to Firebase service account key (json)

                      -
                      \ No newline at end of file diff --git a/docs/interfaces/utils_template.DataModel.html b/docs/interfaces/utils_template.DataModel.html index 574dabf1..cb2f45af 100644 --- a/docs/interfaces/utils_template.DataModel.html +++ b/docs/interfaces/utils_template.DataModel.html @@ -1,11 +1,11 @@ -DataModel | Firebase Engine - v1.5.101

                      Data Model

                      -

                      Hierarchy

                      • DataModel

                      Properties

                      data +DataModel | Firebase Engine - v1.5.102
                      \ No newline at end of file diff --git a/docs/modules/FirebaseEngine.html b/docs/modules/FirebaseEngine.html index e681dbb0..b230f845 100644 --- a/docs/modules/FirebaseEngine.html +++ b/docs/modules/FirebaseEngine.html @@ -1,5 +1,5 @@ -FirebaseEngine | Firebase Engine - v1.5.101
                      \ No newline at end of file diff --git a/docs/modules/bin_firebase_engine.html b/docs/modules/bin_firebase_engine.html index 9c35ee5c..81c239c4 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.101
                      \ 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 919ed426..14472445 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.101
                      \ No newline at end of file diff --git a/docs/modules/index.html b/docs/modules/index.html index 25d9affa..fe337926 100644 --- a/docs/modules/index.html +++ b/docs/modules/index.html @@ -1,4 +1,4 @@ -index | Firebase Engine - v1.5.101
                      \ No newline at end of file diff --git a/docs/modules/jobs_Jobs.html b/docs/modules/jobs_Jobs.html index 6f2f66b0..89c8e8cc 100644 --- a/docs/modules/jobs_Jobs.html +++ b/docs/modules/jobs_Jobs.html @@ -1,5 +1,5 @@ -jobs/Jobs | Firebase Engine - v1.5.101
                      \ No newline at end of file diff --git a/docs/modules/jobs_backup_auth.html b/docs/modules/jobs_backup_auth.html index 772f8d9b..d8d3e65b 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.101
                      \ No newline at end of file diff --git a/docs/modules/jobs_backup_firestore.html b/docs/modules/jobs_backup_firestore.html index e43755b1..8945cd94 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.101
                      \ No newline at end of file diff --git a/docs/modules/jobs_backup_storage.html b/docs/modules/jobs_backup_storage.html index 045901d9..4cdbc4b6 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.101
                      \ No newline at end of file diff --git a/docs/modules/jobs_clean_auth.html b/docs/modules/jobs_clean_auth.html index d56613f4..b385071a 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.101
                      \ No newline at end of file diff --git a/docs/modules/jobs_clean_firestore.html b/docs/modules/jobs_clean_firestore.html index 006af412..ad7f3c42 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.101
                      \ No newline at end of file diff --git a/docs/modules/jobs_clean_storage.html b/docs/modules/jobs_clean_storage.html index b5575171..492138dd 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.101
                      \ No newline at end of file diff --git a/docs/modules/jobs_restore_auth.html b/docs/modules/jobs_restore_auth.html index 35f347da..e4e82e4d 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.101
                      \ No newline at end of file diff --git a/docs/modules/jobs_restore_firestore.html b/docs/modules/jobs_restore_firestore.html index 255ab5c2..90009439 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.101
                      \ No newline at end of file diff --git a/docs/modules/jobs_restore_storage.html b/docs/modules/jobs_restore_storage.html index 4b2c9374..0bd9bed4 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.101
                      \ No newline at end of file diff --git a/docs/modules/utils_AuthConverter.html b/docs/modules/utils_AuthConverter.html index c52a82e5..7d4e926b 100644 --- a/docs/modules/utils_AuthConverter.html +++ b/docs/modules/utils_AuthConverter.html @@ -1,5 +1,5 @@ -utils/AuthConverter | Firebase Engine - v1.5.101
                      \ No newline at end of file diff --git a/docs/modules/utils_FirebaseAdmin.credential.html b/docs/modules/utils_FirebaseAdmin.credential.html index 530c79a7..c45b31db 100644 --- a/docs/modules/utils_FirebaseAdmin.credential.html +++ b/docs/modules/utils_FirebaseAdmin.credential.html @@ -1,8 +1,8 @@ -credential | Firebase Engine - v1.5.101

                      Index

                      Type Aliases

                      Credential +credential | Firebase Engine - v1.5.102
                      \ No newline at end of file diff --git a/docs/modules/utils_FirebaseAdmin.html b/docs/modules/utils_FirebaseAdmin.html index 2bb8a8e8..08e9b656 100644 --- a/docs/modules/utils_FirebaseAdmin.html +++ b/docs/modules/utils_FirebaseAdmin.html @@ -1,8 +1,8 @@ -utils/FirebaseAdmin | Firebase Engine - v1.5.101

                      Module utils/FirebaseAdmin

                      Index

                      Namespaces

                      credential +utils/FirebaseAdmin | Firebase Engine - v1.5.102
                      \ No newline at end of file diff --git a/docs/modules/utils_FirebaseAuth.html b/docs/modules/utils_FirebaseAuth.html index 8ab5159b..18a82591 100644 --- a/docs/modules/utils_FirebaseAuth.html +++ b/docs/modules/utils_FirebaseAuth.html @@ -1,8 +1,8 @@ -utils/FirebaseAuth | Firebase Engine - v1.5.101

                      Module utils/FirebaseAuth

                      Index

                      Classes

                      Auth +utils/FirebaseAuth | Firebase Engine - v1.5.102
                      \ No newline at end of file diff --git a/docs/modules/utils_FirebaseFirestore.html b/docs/modules/utils_FirebaseFirestore.html index 1056bc62..1e1b0cac 100644 --- a/docs/modules/utils_FirebaseFirestore.html +++ b/docs/modules/utils_FirebaseFirestore.html @@ -1,11 +1,11 @@ -utils/FirebaseFirestore | Firebase Engine - v1.5.101

                      Module utils/FirebaseFirestore

                      Index

                      Classes

                      DocumentReference +utils/FirebaseFirestore | Firebase Engine - v1.5.102
                      \ No newline at end of file diff --git a/docs/modules/utils_FirebaseStorage.html b/docs/modules/utils_FirebaseStorage.html index bc0a25b8..d0497ce4 100644 --- a/docs/modules/utils_FirebaseStorage.html +++ b/docs/modules/utils_FirebaseStorage.html @@ -1,6 +1,6 @@ -utils/FirebaseStorage | Firebase Engine - v1.5.101

                      Module utils/FirebaseStorage

                      Index

                      Classes

                      Storage +utils/FirebaseStorage | Firebase Engine - v1.5.102
                      \ No newline at end of file diff --git a/docs/modules/utils_FirestoreConverter.html b/docs/modules/utils_FirestoreConverter.html index f8db643d..ecb9a2de 100644 --- a/docs/modules/utils_FirestoreConverter.html +++ b/docs/modules/utils_FirestoreConverter.html @@ -1,5 +1,5 @@ -utils/FirestoreConverter | Firebase Engine - v1.5.101
                      \ No newline at end of file diff --git a/docs/modules/utils_Logger.html b/docs/modules/utils_Logger.html index 498d81aa..8c1cef70 100644 --- a/docs/modules/utils_Logger.html +++ b/docs/modules/utils_Logger.html @@ -1,5 +1,5 @@ -utils/Logger | Firebase Engine - v1.5.101
                      \ No newline at end of file diff --git a/docs/modules/utils_StorageConverter.html b/docs/modules/utils_StorageConverter.html index 598c707a..27cdc89e 100644 --- a/docs/modules/utils_StorageConverter.html +++ b/docs/modules/utils_StorageConverter.html @@ -1,5 +1,5 @@ -utils/StorageConverter | Firebase Engine - v1.5.101
                      \ No newline at end of file diff --git a/docs/modules/utils_initialization.html b/docs/modules/utils_initialization.html index e7346253..4a802093 100644 --- a/docs/modules/utils_initialization.html +++ b/docs/modules/utils_initialization.html @@ -1,4 +1,4 @@ -utils/initialization | Firebase Engine - v1.5.101

                      Module utils/initialization

                      Index

                      Classes

                      Writer +utils/initialization | Firebase Engine - v1.5.102
                      \ No newline at end of file diff --git a/docs/modules/utils_randomStr.html b/docs/modules/utils_randomStr.html index 96f145d9..781d30b4 100644 --- a/docs/modules/utils_randomStr.html +++ b/docs/modules/utils_randomStr.html @@ -1,5 +1,5 @@ -utils/randomStr | Firebase Engine - v1.5.101
                      \ No newline at end of file diff --git a/docs/modules/utils_template.html b/docs/modules/utils_template.html index 635a40e1..6b28b1ab 100644 --- a/docs/modules/utils_template.html +++ b/docs/modules/utils_template.html @@ -1,10 +1,10 @@ -utils/template | Firebase Engine - v1.5.101

                      Module utils/template

                      Index

                      Classes

                      JobBackupServiceRestoreTemplate +utils/template | Firebase Engine - v1.5.102
                      \ 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 8aae4abd..2e662010 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.101
                      Credential: TCredential

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

                      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.

                      -
                      \ No newline at end of file diff --git a/docs/types/utils_FirebaseAuth.HashAlgorithmType.html b/docs/types/utils_FirebaseAuth.HashAlgorithmType.html index 9032a10e..eaabfeba 100644 --- a/docs/types/utils_FirebaseAuth.HashAlgorithmType.html +++ b/docs/types/utils_FirebaseAuth.HashAlgorithmType.html @@ -1,4 +1,4 @@ -HashAlgorithmType | Firebase Engine - v1.5.101
                      HashAlgorithmType: "SCRYPT" | "STANDARD_SCRYPT" | "HMAC_SHA512" | "HMAC_SHA256" | "HMAC_SHA1" | "HMAC_MD5" | "MD5" | "PBKDF_SHA1" | "BCRYPT" | "PBKDF2_SHA256" | "SHA512" | "SHA256" | "SHA1"
                      HashAlgorithmType: "SCRYPT" | "STANDARD_SCRYPT" | "HMAC_SHA512" | "HMAC_SHA256" | "HMAC_SHA1" | "HMAC_MD5" | "MD5" | "PBKDF_SHA1" | "BCRYPT" | "PBKDF2_SHA256" | "SHA512" | "SHA256" | "SHA1"
                      \ No newline at end of file diff --git a/docs/types/utils_FirebaseFirestore.DocumentData.html b/docs/types/utils_FirebaseFirestore.DocumentData.html index 419e8f65..65086bd6 100644 --- a/docs/types/utils_FirebaseFirestore.DocumentData.html +++ b/docs/types/utils_FirebaseFirestore.DocumentData.html @@ -1,6 +1,6 @@ -DocumentData | Firebase Engine - v1.5.101
                      DocumentData: {
                          [field: string]: DocumentFieldValue;
                      }

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

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

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

                      -

                      Type declaration

                      • [field: string]: DocumentFieldValue
                      \ No newline at end of file diff --git a/docs/variables/utils_FirebaseAdmin.apps.html b/docs/variables/utils_FirebaseAdmin.apps.html index 936a606d..7f6fab83 100644 --- a/docs/variables/utils_FirebaseAdmin.apps.html +++ b/docs/variables/utils_FirebaseAdmin.apps.html @@ -1,4 +1,4 @@ -apps | Firebase Engine - v1.5.101
                      \ No newline at end of file diff --git a/docs/variables/utils_initialization.writers.html b/docs/variables/utils_initialization.writers.html index 333b5917..84aa4b83 100644 --- a/docs/variables/utils_initialization.writers.html +++ b/docs/variables/utils_initialization.writers.html @@ -1,5 +1,5 @@ -writers | Firebase Engine - v1.5.101
                      \ No newline at end of file