diff --git a/docs/classes/FirebaseEngine.FirebaseEngine.html b/docs/classes/FirebaseEngine.FirebaseEngine.html index 1aae6298..396ad8fe 100644 --- a/docs/classes/FirebaseEngine.FirebaseEngine.html +++ b/docs/classes/FirebaseEngine.FirebaseEngine.html @@ -1,17 +1,17 @@ -FirebaseEngine | Firebase Engine - v1.5.139

Firebase Engine to copy data

-

Constructors

constructor +FirebaseEngine | Firebase Engine - v1.5.140

Firebase Engine to copy data

+

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 afcd52fa..a2716a17 100644 --- a/docs/classes/jobs_Jobs.Jobs.html +++ b/docs/classes/jobs_Jobs.Jobs.html @@ -1,5 +1,5 @@ -Jobs | Firebase Engine - v1.5.139

Jobs Class

-

Hierarchy (view full)

Constructors

constructor +Jobs | Firebase Engine - v1.5.140

Jobs Class

+

Hierarchy (view full)

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 40354c1f..62b8e436 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.139

Job backup

-

Hierarchy (view full)

Constructors

constructor +JobBackupAuth | Firebase Engine - v1.5.140

Job backup

+

Hierarchy (view full)

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 51b1bef2..0f403162 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.139

Job backup

-

Hierarchy (view full)

Constructors

constructor +JobBackupFirestore | Firebase Engine - v1.5.140

Job backup

+

Hierarchy (view full)

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 5718913c..35ca5d65 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.139

Job backup

-

Hierarchy (view full)

Constructors

constructor +JobBackupStorage | Firebase Engine - v1.5.140

Job backup

+

Hierarchy (view full)

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 956d56e9..f228e61f 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.139

Job class

-

Hierarchy (view full)

Constructors

constructor +JobCleanAuth | Firebase Engine - v1.5.140

Job class

+

Hierarchy (view full)

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 327a2350..cc67d976 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.139

Job class

-

Hierarchy (view full)

Constructors

constructor +JobCleanFirestore | Firebase Engine - v1.5.140

Job class

+

Hierarchy (view full)

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 de2af703..cc11510c 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.139

Job class

-

Hierarchy (view full)

Constructors

constructor +JobCleanStorage | Firebase Engine - v1.5.140

Job class

+

Hierarchy (view full)

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 6ea9b5b9..2db934be 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.139

Job restore

-

Hierarchy (view full)

Constructors

constructor +JobRestoreAuth | Firebase Engine - v1.5.140

Job restore

+

Hierarchy (view full)

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 c05e5c5d..9101879d 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.139

Job restore

-

Hierarchy (view full)

Constructors

constructor +JobRestoreFirestore | Firebase Engine - v1.5.140

Job restore

+

Hierarchy (view full)

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 afcc4e60..041c2fda 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.139

Job restore

-

Hierarchy (view full)

Constructors

constructor +JobRestoreStorage | Firebase Engine - v1.5.140

Job restore

+

Hierarchy (view full)

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 af182bdc..ad0ad2b2 100644 --- a/docs/classes/utils_AuthConverter.AuthConverter.html +++ b/docs/classes/utils_AuthConverter.AuthConverter.html @@ -1,16 +1,16 @@ -AuthConverter | Firebase Engine - v1.5.139

Auth Document converter

-

Constructors

constructor +AuthConverter | Firebase Engine - v1.5.140

Auth Document converter

+

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 e0904214..b49d4b2e 100644 --- a/docs/classes/utils_FirebaseAuth.Auth.html +++ b/docs/classes/utils_FirebaseAuth.Auth.html @@ -1,4 +1,4 @@ -Auth | Firebase Engine - v1.5.139

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

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 15a1f684..2a53dc3d 100644 --- a/docs/classes/utils_FirebaseAuth.UserRecord.html +++ b/docs/classes/utils_FirebaseAuth.UserRecord.html @@ -1,4 +1,4 @@ -UserRecord | Firebase Engine - v1.5.139

    Represents a user.

    +UserRecord | Firebase Engine - v1.5.140

    Represents a user.

    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 e4a374d4..f30114bb 100644 --- a/docs/classes/utils_FirebaseFirestore.DocumentReference.html +++ b/docs/classes/utils_FirebaseFirestore.DocumentReference.html @@ -1,4 +1,4 @@ -DocumentReference | Firebase Engine - v1.5.139

    Class DocumentReference<AppModelType, DbModelType>

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

    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.

    -
  • Parameters

    • converter: null

    Returns DocumentReference<DocumentData, DocumentData>

  • \ No newline at end of file diff --git a/docs/classes/utils_FirebaseFirestore.Firestore.html b/docs/classes/utils_FirebaseFirestore.Firestore.html index 54b7e0c5..be3261a3 100644 --- a/docs/classes/utils_FirebaseFirestore.Firestore.html +++ b/docs/classes/utils_FirebaseFirestore.Firestore.html @@ -1,4 +1,4 @@ -Firestore | Firebase Engine - v1.5.139

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

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

    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 ac88900f..24b89856 100644 --- a/docs/classes/utils_FirebaseFirestore.GeoPoint.html +++ b/docs/classes/utils_FirebaseFirestore.GeoPoint.html @@ -1,4 +1,4 @@ -GeoPoint | Firebase Engine - v1.5.139

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

    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 895e8116..e87294b4 100644 --- a/docs/classes/utils_FirebaseFirestore.Timestamp.html +++ b/docs/classes/utils_FirebaseFirestore.Timestamp.html @@ -1,4 +1,4 @@ -Timestamp | Firebase Engine - v1.5.139

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

    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 220efa70..189a8d86 100644 --- a/docs/classes/utils_FirebaseFirestore.WriteBatch.html +++ b/docs/classes/utils_FirebaseFirestore.WriteBatch.html @@ -1,4 +1,4 @@ -WriteBatch | Firebase Engine - v1.5.139

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

    +WriteBatch | Firebase Engine - v1.5.140

    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 9f5ec5ae..db9ae06f 100644 --- a/docs/classes/utils_FirebaseStorage.Storage.html +++ b/docs/classes/utils_FirebaseStorage.Storage.html @@ -1,4 +1,4 @@ -Storage | Firebase Engine - v1.5.139

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

    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.

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

    Firestore Document converter

    -

    Constructors

    constructor +FirestoreConverter | Firebase Engine - v1.5.140

    Firestore Document converter

    +

    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 2febc20e..134e0c34 100644 --- a/docs/classes/utils_Logger.Logger.html +++ b/docs/classes/utils_Logger.Logger.html @@ -1,14 +1,14 @@ -Logger | Firebase Engine - v1.5.139

    Logger class

    -

    Constructors

    constructor +Logger | Firebase Engine - v1.5.140

    Logger class

    +

    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 c63a333f..fb9e2b6e 100644 --- a/docs/classes/utils_StorageConverter.StorageConverter.html +++ b/docs/classes/utils_StorageConverter.StorageConverter.html @@ -1,12 +1,12 @@ -StorageConverter | Firebase Engine - v1.5.139

    Storage File converter

    -

    Constructors

    constructor +StorageConverter | Firebase Engine - v1.5.140

    Storage File converter

    +

    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 039aa204..4915fc49 100644 --- a/docs/classes/utils_initialization.Writer.html +++ b/docs/classes/utils_initialization.Writer.html @@ -1,13 +1,13 @@ -Writer | Firebase Engine - v1.5.139

    Writer Class for create write streams

    -

    Constructors

    constructor +Writer | Firebase Engine - v1.5.140

    Writer Class for create write streams

    +

    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 28fc0d2e..753b00b5 100644 --- a/docs/classes/utils_template.JobBackupServiceRestoreTemplate.html +++ b/docs/classes/utils_template.JobBackupServiceRestoreTemplate.html @@ -1,5 +1,5 @@ -JobBackupServiceRestoreTemplate | Firebase Engine - v1.5.139

    Job restore

    -

    Hierarchy (view full)

    Constructors

    constructor +JobBackupServiceRestoreTemplate | Firebase Engine - v1.5.140

    Job restore

    +

    Hierarchy (view full)

    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 2417f87e..f06d7f71 100644 --- a/docs/classes/utils_template.JobBackupServiceTemplate.html +++ b/docs/classes/utils_template.JobBackupServiceTemplate.html @@ -1,5 +1,5 @@ -JobBackupServiceTemplate | Firebase Engine - v1.5.139

    Job backup

    -

    Hierarchy (view full)

    Constructors

    constructor +JobBackupServiceTemplate | Firebase Engine - v1.5.140

    Job backup

    +

    Hierarchy (view full)

    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 c6c2bcde..a099ca47 100644 --- a/docs/classes/utils_template.JobOneServiceTemplate.html +++ b/docs/classes/utils_template.JobOneServiceTemplate.html @@ -1,5 +1,5 @@ -JobOneServiceTemplate | Firebase Engine - v1.5.139

    Job class

    -

    Hierarchy (view full)

    Constructors

    constructor +JobOneServiceTemplate | Firebase Engine - v1.5.140

    Job class

    +

    Hierarchy (view full)

    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 36ce7182..07f67b1c 100644 --- a/docs/classes/utils_template.JobOneTemplate.html +++ b/docs/classes/utils_template.JobOneTemplate.html @@ -1,5 +1,5 @@ -JobOneTemplate | Firebase Engine - v1.5.139

    Job One Template Class

    -

    Hierarchy (view full)

    Constructors

    constructor +JobOneTemplate | Firebase Engine - v1.5.140

    Job One Template Class

    +

    Hierarchy (view full)

    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 86db4750..6919d6b1 100644 --- a/docs/classes/utils_template.JobTemplate.html +++ b/docs/classes/utils_template.JobTemplate.html @@ -1,15 +1,15 @@ -JobTemplate | Firebase Engine - v1.5.139

    Job Template Class

    -

    Hierarchy (view full)

    Constructors

    constructor +JobTemplate | Firebase Engine - v1.5.140

    Job Template Class

    +

    Hierarchy (view full)

    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 e847d4bd..67e1e02b 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.139
    • Returns a credential created from the +applicationDefault | Firebase Engine - v1.5.140

      • 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 91c6a596..b5c22471 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.139
      • Returns a credential created from the provided service account that grants +cert | Firebase Engine - v1.5.140

        • 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 90f76c69..0aa91492 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.139
        • Returns a credential created from the provided refresh token that grants +refreshToken | Firebase Engine - v1.5.140

          • 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 4ec5ee8b..744637e9 100644 --- a/docs/functions/utils_FirebaseAdmin.initializeApp.html +++ b/docs/functions/utils_FirebaseAdmin.initializeApp.html @@ -1,4 +1,4 @@ -initializeApp | Firebase Engine - v1.5.139
          • Parameters

            • Optional options: AppOptions
            • Optional appName: string

            Returns App

          • Parameters

            • Optional options: AppOptions
            • Optional appName: string

            Returns App

          \ No newline at end of file diff --git a/docs/functions/utils_FirebaseAuth.getAuth.html b/docs/functions/utils_FirebaseAuth.getAuth.html index d10e0e96..334f5832 100644 --- a/docs/functions/utils_FirebaseAuth.getAuth.html +++ b/docs/functions/utils_FirebaseAuth.getAuth.html @@ -1,4 +1,4 @@ -getAuth | Firebase Engine - v1.5.139
          • Gets the Auth service for the default app or a +getAuth | Firebase Engine - v1.5.140

            • 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 9c225230..e7eb79f1 100644 --- a/docs/functions/utils_FirebaseFirestore.getFirestore.html +++ b/docs/functions/utils_FirebaseFirestore.getFirestore.html @@ -1,4 +1,4 @@ -getFirestore | Firebase Engine - v1.5.139
            • Gets the default Firestore +getFirestore | Firebase Engine - v1.5.140

              • 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 d64acbb4..7cc0af0c 100644 --- a/docs/functions/utils_FirebaseStorage.getStorage.html +++ b/docs/functions/utils_FirebaseStorage.getStorage.html @@ -1,4 +1,4 @@ -getStorage | Firebase Engine - v1.5.139
              • Gets the Storage service for the default app or a given app.

                +getStorage | Firebase Engine - v1.5.140
                • 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 e905e35f..6e8e7417 100644 --- a/docs/functions/utils_initialization.cmdParser.html +++ b/docs/functions/utils_initialization.cmdParser.html @@ -1,5 +1,5 @@ -cmdParser | Firebase Engine - v1.5.139
                \ No newline at end of file diff --git a/docs/functions/utils_initialization.createWriteFileStream.html b/docs/functions/utils_initialization.createWriteFileStream.html index b475f875..97e36f2f 100644 --- a/docs/functions/utils_initialization.createWriteFileStream.html +++ b/docs/functions/utils_initialization.createWriteFileStream.html @@ -1,6 +1,6 @@ -createWriteFileStream | Firebase Engine - v1.5.139
                • Create write stream

                  +createWriteFileStream | Firebase Engine - v1.5.140
                  \ No newline at end of file diff --git a/docs/functions/utils_initialization.initialization.html b/docs/functions/utils_initialization.initialization.html index 128d12a2..536944f1 100644 --- a/docs/functions/utils_initialization.initialization.html +++ b/docs/functions/utils_initialization.initialization.html @@ -1,6 +1,6 @@ -initialization | Firebase Engine - v1.5.139
                  • App initialization

                    +initialization | Firebase Engine - v1.5.140
                    \ No newline at end of file diff --git a/docs/functions/utils_randomStr.randomStr.html b/docs/functions/utils_randomStr.randomStr.html index 321e4f03..f19b9776 100644 --- a/docs/functions/utils_randomStr.randomStr.html +++ b/docs/functions/utils_randomStr.randomStr.html @@ -1,6 +1,6 @@ -randomStr | Firebase Engine - v1.5.139
                    • Random byte string like /0-9a-zA-Z/

                      +randomStr | Firebase Engine - v1.5.140
                      • Random byte string like /0-9a-zA-Z/

                        Parameters

                        • length: number

                          code length

                          -

                        Returns string

                      \ No newline at end of file diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 10189837..1b76a519 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1,4 +1,4 @@ -Firebase Engine - v1.5.139
                      \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index ee7675bc..8c0d6d78 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -Firebase Engine - v1.5.139

                      Firebase Engine - v1.5.139

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

                      Firebase Engine - v1.5.140

                      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

                      -
                      \ No newline at end of file diff --git a/docs/interfaces/utils_FirebaseAdmin.App.html b/docs/interfaces/utils_FirebaseAdmin.App.html index db67c448..a0da266d 100644 --- a/docs/interfaces/utils_FirebaseAdmin.App.html +++ b/docs/interfaces/utils_FirebaseAdmin.App.html @@ -1,4 +1,4 @@ -App | Firebase Engine - v1.5.139

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

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

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

                      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

                      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 f1ac5ec6..1d6a9548 100644 --- a/docs/interfaces/utils_initialization.Settings.html +++ b/docs/interfaces/utils_initialization.Settings.html @@ -1,5 +1,5 @@ -Settings | Firebase Engine - v1.5.139

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

                      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

                      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 c972fac9..605b2bf8 100644 --- a/docs/interfaces/utils_initialization.SettingsBeforeInitialization.html +++ b/docs/interfaces/utils_initialization.SettingsBeforeInitialization.html @@ -1,5 +1,5 @@ -SettingsBeforeInitialization | Firebase Engine - v1.5.139

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

                      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?: 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 179f0984..bcb2b498 100644 --- a/docs/interfaces/utils_template.DataModel.html +++ b/docs/interfaces/utils_template.DataModel.html @@ -1,11 +1,11 @@ -DataModel | Firebase Engine - v1.5.139

                      Data Model

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

                      Properties

                      data +DataModel | Firebase Engine - v1.5.140

                      Data Model

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

                      Properties

                      Properties

                      data: string

                      document data

                      -
                      path: string

                      document path

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

                      service type

                      -
                      \ No newline at end of file diff --git a/docs/modules/FirebaseEngine.html b/docs/modules/FirebaseEngine.html index 785c018f..24182c17 100644 --- a/docs/modules/FirebaseEngine.html +++ b/docs/modules/FirebaseEngine.html @@ -1,5 +1,5 @@ -FirebaseEngine | Firebase Engine - v1.5.139

                      Module FirebaseEngine

                      Index

                      Classes

                      Module FirebaseEngine

                      Index

                      Classes

                      \ No newline at end of file diff --git a/docs/modules/bin_firebase_engine.html b/docs/modules/bin_firebase_engine.html index 66490574..325855cb 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.139
                      \ 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 2ec6f9ce..a40c7708 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.139
                      \ No newline at end of file diff --git a/docs/modules/index.html b/docs/modules/index.html index 33c6b21e..7d33c552 100644 --- a/docs/modules/index.html +++ b/docs/modules/index.html @@ -1,4 +1,4 @@ -index | Firebase Engine - v1.5.139
                      \ No newline at end of file diff --git a/docs/modules/jobs_Jobs.html b/docs/modules/jobs_Jobs.html index 6516d6a1..103591d9 100644 --- a/docs/modules/jobs_Jobs.html +++ b/docs/modules/jobs_Jobs.html @@ -1,5 +1,5 @@ -jobs/Jobs | Firebase Engine - v1.5.139

                      Module jobs/Jobs

                      Index

                      Classes

                      Module jobs/Jobs

                      Index

                      Classes

                      \ No newline at end of file diff --git a/docs/modules/jobs_backup_auth.html b/docs/modules/jobs_backup_auth.html index 97b623bc..d613459a 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.139

                      Module jobs/backup/auth

                      Index

                      Classes

                      Module jobs/backup/auth

                      Index

                      Classes

                      \ No newline at end of file diff --git a/docs/modules/jobs_backup_firestore.html b/docs/modules/jobs_backup_firestore.html index ee762631..41809231 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.139
                      \ No newline at end of file diff --git a/docs/modules/jobs_backup_storage.html b/docs/modules/jobs_backup_storage.html index de08ce05..1d666f53 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.139
                      \ No newline at end of file diff --git a/docs/modules/jobs_clean_auth.html b/docs/modules/jobs_clean_auth.html index 6cefbad2..93487d7f 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.139

                      Module jobs/clean/auth

                      Index

                      Classes

                      Module jobs/clean/auth

                      Index

                      Classes

                      \ No newline at end of file diff --git a/docs/modules/jobs_clean_firestore.html b/docs/modules/jobs_clean_firestore.html index 25c3f650..acd80364 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.139
                      \ No newline at end of file diff --git a/docs/modules/jobs_clean_storage.html b/docs/modules/jobs_clean_storage.html index b16ae474..2d31957c 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.139

                      Module jobs/clean/storage

                      Index

                      Classes

                      Module jobs/clean/storage

                      Index

                      Classes

                      \ No newline at end of file diff --git a/docs/modules/jobs_restore_auth.html b/docs/modules/jobs_restore_auth.html index 3f1e7b62..5bcfe8cf 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.139

                      Module jobs/restore/auth

                      Index

                      Classes

                      Module jobs/restore/auth

                      Index

                      Classes

                      \ No newline at end of file diff --git a/docs/modules/jobs_restore_firestore.html b/docs/modules/jobs_restore_firestore.html index e0ff1cf0..3dc58a04 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.139
                      \ No newline at end of file diff --git a/docs/modules/jobs_restore_storage.html b/docs/modules/jobs_restore_storage.html index 5a5570fe..e186f54b 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.139
                      \ No newline at end of file diff --git a/docs/modules/utils_AuthConverter.html b/docs/modules/utils_AuthConverter.html index 44a99fb9..0c13681e 100644 --- a/docs/modules/utils_AuthConverter.html +++ b/docs/modules/utils_AuthConverter.html @@ -1,5 +1,5 @@ -utils/AuthConverter | Firebase Engine - v1.5.139

                      Module utils/AuthConverter

                      Index

                      Classes

                      Module utils/AuthConverter

                      Index

                      Classes

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

                      Index

                      Type Aliases

                      Credential +credential | Firebase Engine - v1.5.140

                      Index

                      Type Aliases

                      Functions

                      \ No newline at end of file diff --git a/docs/modules/utils_FirebaseAdmin.html b/docs/modules/utils_FirebaseAdmin.html index 928ddf46..9678f3e8 100644 --- a/docs/modules/utils_FirebaseAdmin.html +++ b/docs/modules/utils_FirebaseAdmin.html @@ -1,8 +1,8 @@ -utils/FirebaseAdmin | Firebase Engine - v1.5.139

                      Module utils/FirebaseAdmin

                      Index

                      Namespaces

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

                      Module utils/FirebaseAdmin

                      Index

                      Namespaces

                      Interfaces

                      Variables

                      Functions

                      \ No newline at end of file diff --git a/docs/modules/utils_FirebaseAuth.html b/docs/modules/utils_FirebaseAuth.html index 84e941f0..80d7430e 100644 --- a/docs/modules/utils_FirebaseAuth.html +++ b/docs/modules/utils_FirebaseAuth.html @@ -1,8 +1,8 @@ -utils/FirebaseAuth | Firebase Engine - v1.5.139

                      Module utils/FirebaseAuth

                      Index

                      Classes

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

                      Module utils/FirebaseAuth

                      Index

                      Classes

                      Type Aliases

                      Functions

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

                      Module utils/FirebaseFirestore

                      Index

                      Classes

                      DocumentReference +utils/FirebaseFirestore | Firebase Engine - v1.5.140
                      \ No newline at end of file diff --git a/docs/modules/utils_FirebaseStorage.html b/docs/modules/utils_FirebaseStorage.html index 89d95cc2..bb237f70 100644 --- a/docs/modules/utils_FirebaseStorage.html +++ b/docs/modules/utils_FirebaseStorage.html @@ -1,6 +1,6 @@ -utils/FirebaseStorage | Firebase Engine - v1.5.139

                      Module utils/FirebaseStorage

                      Index

                      Classes

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

                      Module utils/FirebaseStorage

                      Index

                      Classes

                      Functions

                      \ No newline at end of file diff --git a/docs/modules/utils_FirestoreConverter.html b/docs/modules/utils_FirestoreConverter.html index 8dbdb042..b99b186b 100644 --- a/docs/modules/utils_FirestoreConverter.html +++ b/docs/modules/utils_FirestoreConverter.html @@ -1,5 +1,5 @@ -utils/FirestoreConverter | Firebase Engine - v1.5.139
                      \ No newline at end of file diff --git a/docs/modules/utils_Logger.html b/docs/modules/utils_Logger.html index ca1c2ce8..9acb8efc 100644 --- a/docs/modules/utils_Logger.html +++ b/docs/modules/utils_Logger.html @@ -1,5 +1,5 @@ -utils/Logger | Firebase Engine - v1.5.139

                      Module utils/Logger

                      Index

                      Classes

                      Module utils/Logger

                      Index

                      Classes

                      \ No newline at end of file diff --git a/docs/modules/utils_StorageConverter.html b/docs/modules/utils_StorageConverter.html index 788b899c..74717638 100644 --- a/docs/modules/utils_StorageConverter.html +++ b/docs/modules/utils_StorageConverter.html @@ -1,5 +1,5 @@ -utils/StorageConverter | Firebase Engine - v1.5.139
                      \ No newline at end of file diff --git a/docs/modules/utils_initialization.html b/docs/modules/utils_initialization.html index 0136cd95..66b153a3 100644 --- a/docs/modules/utils_initialization.html +++ b/docs/modules/utils_initialization.html @@ -1,4 +1,4 @@ -utils/initialization | Firebase Engine - v1.5.139

                      Module utils/initialization

                      Index

                      Classes

                      Writer +utils/initialization | Firebase Engine - v1.5.140
                      \ No newline at end of file diff --git a/docs/modules/utils_randomStr.html b/docs/modules/utils_randomStr.html index 748a67d4..eced5e03 100644 --- a/docs/modules/utils_randomStr.html +++ b/docs/modules/utils_randomStr.html @@ -1,5 +1,5 @@ -utils/randomStr | Firebase Engine - v1.5.139

                      Module utils/randomStr

                      Index

                      Functions

                      Module utils/randomStr

                      Index

                      Functions

                      \ No newline at end of file diff --git a/docs/modules/utils_template.html b/docs/modules/utils_template.html index 4b3311f6..b7d09f7e 100644 --- a/docs/modules/utils_template.html +++ b/docs/modules/utils_template.html @@ -1,10 +1,10 @@ -utils/template | Firebase Engine - v1.5.139

                      Module utils/template

                      Index

                      Classes

                      JobBackupServiceRestoreTemplate +utils/template | Firebase Engine - v1.5.140
                      \ 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 c88162c3..259dd82c 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.139
                      Credential: TCredential

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

                      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 4019906b..62d618da 100644 --- a/docs/types/utils_FirebaseAuth.HashAlgorithmType.html +++ b/docs/types/utils_FirebaseAuth.HashAlgorithmType.html @@ -1,4 +1,4 @@ -HashAlgorithmType | Firebase Engine - v1.5.139
                      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 d3ff6fe8..b9e02e77 100644 --- a/docs/types/utils_FirebaseFirestore.DocumentData.html +++ b/docs/types/utils_FirebaseFirestore.DocumentData.html @@ -1,6 +1,6 @@ -DocumentData | Firebase Engine - v1.5.139
                      DocumentData: {
                          [field: string]: DocumentFieldValue;
                      }

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

                      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 6f06e56b..748e924c 100644 --- a/docs/variables/utils_FirebaseAdmin.apps.html +++ b/docs/variables/utils_FirebaseAdmin.apps.html @@ -1,4 +1,4 @@ -apps | Firebase Engine - v1.5.139
                      apps: (app.App | null)[]
                      apps: (app.App | null)[]
                      \ No newline at end of file diff --git a/docs/variables/utils_initialization.writers.html b/docs/variables/utils_initialization.writers.html index c296b7bd..8085b8ff 100644 --- a/docs/variables/utils_initialization.writers.html +++ b/docs/variables/utils_initialization.writers.html @@ -1,5 +1,5 @@ -writers | Firebase Engine - v1.5.139
                      writers: {
                          [key: string]: Writer;
                      } = {}

                      write streams

                      -

                      Type declaration

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

                      write streams

                      +

                      Type declaration

                      \ No newline at end of file