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

Class FirebaseEngine

Firebase Engine to copy data

-

Constructors

constructor +FirebaseEngine | Firebase Engine - v1.5.127

Class FirebaseEngine

Firebase Engine to copy data

+

Constructors

constructor

Properties

admin jobs settings store

Methods

exit -

Constructors

constructor

Properties

Private admin

admin: App

firebase app

-

jobs

jobs: Jobs

Firebase Engine Jobs

-

Private settings

settings: Settings

settings object

-

Private store

store: Storage

Google cloud storage app

-

Methods

exit

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/jobs_Jobs.Jobs.html b/docs/classes/jobs_Jobs.Jobs.html index 3602c862..3c7bb8a6 100644 --- a/docs/classes/jobs_Jobs.Jobs.html +++ b/docs/classes/jobs_Jobs.Jobs.html @@ -1,21 +1,21 @@ -Jobs | Firebase Engine - v1.5.126

Class Jobs

Jobs Class

-

Hierarchy (view full)

Constructors

constructor +Jobs | Firebase Engine - v1.5.127

Class Jobs

Jobs Class

+

Hierarchy (view full)

Constructors

constructor

Properties

admin backup clean restore settings store -

Constructors

constructor

Properties

admin

admin: App

firebase app

-

backup

backup: JobsBackup

backup jobs

-

clean

clean: JobsClean

clean jobs

-

restore

restore: JobsRestore

restore jobs

-

settings

settings: Settings

settings object

-

store

store: Storage

Google cloud storage app

-

Settings

Member Visibility

Theme

On This Page

\ 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 d54b6b79..76e6de37 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.126

Class JobBackupAuth

Job backup

-

Hierarchy (view full)

Constructors

constructor +JobBackupAuth | Firebase Engine - v1.5.127

Class JobBackupAuth

Job backup

+

Hierarchy (view full)

Constructors

constructor

Properties

admin auth counter @@ -11,21 +11,21 @@

Methods

getWorkTime recursiveBackup run -

Constructors

constructor

Properties

admin

admin: App

firebase app

-

Private auth

auth: Auth

firebase auth app

-

counter

counter: number = 0

operation counter

-

settings

settings: Settings

settings object

-

startTimestamp

startTimestamp: number

start timestamp

-

store

store: Storage

Google cloud storage app

-

stringiferStream

stringiferStream: Transform

object to string stream

-

writer

writer: Writer

Writer streams in object

-

Methods

getWorkTime

Private recursiveBackup

  • recursiveBackup(nextPageToken?): Promise<void>

  • recursive backup function

    -

    Parameters

    • Optional nextPageToken: string

    Returns Promise<void>

run

Settings

Member Visibility

Theme

On This Page

\ 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 0206dda3..ec79239d 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.126

Class JobBackupFirestore

Job backup

-

Hierarchy (view full)

Constructors

constructor +JobBackupFirestore | Firebase Engine - v1.5.127

Class JobBackupFirestore

Job backup

+

Hierarchy (view full)

Constructors

constructor

Properties

admin counter firestore @@ -12,22 +12,22 @@ getWorkTime recursiveBackup run -

Constructors

constructor

Properties

admin

admin: App

firebase app

-

counter

counter: number = 0

operation counter

-

Private firestore

firestore: Firestore

firebase firestore app

-

settings

settings: Settings

settings object

-

startTimestamp

startTimestamp: number

start timestamp

-

store

store: Storage

Google cloud storage app

-

stringiferStream

stringiferStream: Transform

object to string stream

-

writer

writer: Writer

Writer streams in object

-

Methods

Private documentBackup

getWorkTime

Private recursiveBackup

run

Settings

Member Visibility

Theme

On This Page

\ 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 90c1251d..c8faf6ad 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.126

Class JobBackupStorage

Job backup

-

Hierarchy (view full)

Constructors

constructor +JobBackupStorage | Firebase Engine - v1.5.127

Class JobBackupStorage

Job backup

+

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

backupFile getWorkTime run -

Constructors

constructor

Properties

admin

admin: App

firebase app

-

counter

counter: number = 0

operation counter

-

settings

settings: Settings

settings object

-

startTimestamp

startTimestamp: number

start timestamp

-

store

store: Storage

Google cloud storage app

-

stringiferStream

stringiferStream: Transform

object to string stream

-

writer

writer: Writer

Writer streams in object

-

Methods

Private backupFile

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

  • backup one file function

    -

    Parameters

    • bucket: Bucket
    • file: File

    Returns Promise<void>

getWorkTime

run

Settings

Member Visibility

Theme

On This Page

\ 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 0c23ad89..cdd33ce8 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.126

Class JobCleanAuth

Job class

-

Hierarchy (view full)

Constructors

constructor +JobCleanAuth | Firebase Engine - v1.5.127

Class JobCleanAuth

Job class

+

Hierarchy (view full)

Constructors

constructor

Properties

admin auth counter @@ -9,19 +9,19 @@

Methods

getWorkTime recursiveClean run -

Constructors

constructor

Properties

admin

admin: App

firebase app

-

Private auth

auth: Auth

firebase auth app

-

counter

counter: number = 0

operation counter

-

settings

settings: Settings

settings object

-

startTimestamp

startTimestamp: number

start timestamp

-

store

store: Storage

Google cloud storage app

-

Methods

getWorkTime

Private recursiveClean

  • recursiveClean(nextPageToken?): Promise<void>

  • recursive clean function

    -

    Parameters

    • Optional nextPageToken: string

    Returns Promise<void>

run

Settings

Member Visibility

Theme

On This Page

\ 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 5258ae02..ecc42804 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.126

Class JobCleanFirestore

Job class

-

Hierarchy (view full)

Constructors

constructor +JobCleanFirestore | Firebase Engine - v1.5.127

Class JobCleanFirestore

Job class

+

Hierarchy (view full)

Constructors

constructor

Properties

admin batch counter @@ -12,22 +12,22 @@ getWorkTime recursiveClean run -

Constructors

constructor

Properties

admin

admin: App

firebase app

-

Private batch

batch: WriteBatch

batch object

-

counter

counter: number = 0

operation counter

-

Private firestore

firestore: Firestore

firebase firestore app

-

settings

settings: Settings

settings object

-

startTimestamp

startTimestamp: number

start timestamp

-

store

store: Storage

Google cloud storage app

-

Static Private batchSize

batchSize: number = 500

document on one batch

-

Methods

Private batchClean

getWorkTime

Private recursiveClean

run

Settings

Member Visibility

Theme

On This Page

\ 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 e60a503a..9dbbd602 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.126

Class JobCleanStorage

Job class

-

Hierarchy (view full)

Constructors

constructor +JobCleanStorage | Firebase Engine - v1.5.127

Class JobCleanStorage

Job class

+

Hierarchy (view full)

Constructors

constructor

Properties

admin counter settings @@ -7,17 +7,17 @@ store

Methods

getWorkTime run -

Constructors

constructor

Properties

admin

admin: App

firebase app

-

counter

counter: number = 0

operation counter

-

settings

settings: Settings

settings object

-

startTimestamp

startTimestamp: number

start timestamp

-

store

store: Storage

Google cloud storage app

-

Methods

getWorkTime

run

Settings

Member Visibility

Theme

On This Page

\ 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 e06e9ebb..812edf0e 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.126

Class JobRestoreAuth

Job restore

-

Hierarchy (view full)

Constructors

constructor +JobRestoreAuth | Firebase Engine - v1.5.127

Class JobRestoreAuth

Job restore

+

Hierarchy (view full)

Constructors

constructor

Properties

admin auth counter @@ -13,29 +13,29 @@ writeStream

Methods

getWorkTime run -

Constructors

constructor

Properties

admin

admin: App

firebase app

-

Private auth

auth: Auth

firebase auth app

-

counter

counter: number = 0

operation counter

-

fileStream

fileStream: ReadStream

file read stream

-

Optional gunzipStream

gunzipStream?: Gunzip

unzip stream

-

parserStream

parserStream: Transform

string to object stream

-

settings

settings: Settings

settings object

-

startTimestamp

startTimestamp: number

start timestamp

-

store

store: Storage

Google cloud storage app

-

Private writeBuffer

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

buffer for write to project

+

Constructors

constructor

Properties

admin

admin: App

firebase app

+

Private auth

auth: Auth

firebase auth app

+

counter

counter: number = 0

operation counter

+

fileStream

fileStream: ReadStream

file read stream

+

Optional gunzipStream

gunzipStream?: Gunzip

unzip stream

+

parserStream

parserStream: Transform

string to object stream

+

settings

settings: Settings

settings object

+

startTimestamp

startTimestamp: number

start timestamp

+

store

store: Storage

Google cloud storage app

+

Private writeBuffer

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

buffer for write to project

Type declaration

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

    array of user

  • batchSize: number

    batch size

  • clear: Function

    clean this buffer

  • commit: Function

    write this buffer to project and clean it

  • iteration: number

    iteration

  • set: Function

    add user to this buffer

    -

Private writeStream

writeStream: Writable

write user to project stream

-

Methods

getWorkTime

run

Settings

Member Visibility

Theme

On This Page

\ 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 ce31e55a..6bf97260 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.126

Class JobRestoreFirestore

Job restore

-

Hierarchy (view full)

Constructors

constructor +JobRestoreFirestore | Firebase Engine - v1.5.127

Class JobRestoreFirestore

Job restore

+

Hierarchy (view full)

Constructors

constructor

Properties

admin counter fileStream @@ -13,29 +13,29 @@ writeStream

Methods

getWorkTime run -

Constructors

constructor

Properties

admin

admin: App

firebase app

-

counter

counter: number = 0

operation counter

-

fileStream

fileStream: ReadStream

file read stream

-

Private firestore

firestore: Firestore

firebase firestore app

-

Optional gunzipStream

gunzipStream?: Gunzip

unzip stream

-

parserStream

parserStream: Transform

string to object stream

-

settings

settings: Settings

settings object

-

startTimestamp

startTimestamp: number

start timestamp

-

store

store: Storage

Google cloud storage app

-

Private writeBuffer

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

buffer for write to project

+

Constructors

constructor

Properties

admin

admin: App

firebase app

+

counter

counter: number = 0

operation counter

+

fileStream

fileStream: ReadStream

file read stream

+

Private firestore

firestore: Firestore

firebase firestore app

+

Optional gunzipStream

gunzipStream?: Gunzip

unzip stream

+

parserStream

parserStream: Transform

string to object stream

+

settings

settings: Settings

settings object

+

startTimestamp

startTimestamp: number

start timestamp

+

store

store: Storage

Google cloud storage app

+

Private writeBuffer

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

buffer for write to project

Type declaration

  • batch: WriteBatch

    Firestore Writebatch

  • batchSize: number

    batch size

  • clear: Function

    clean this buffer

  • commit: Function

    write this buffer to project and clean it

  • iteration: number

    iteration

  • set: Function

    add document to this buffer

    -

Private writeStream

writeStream: Writable

write document to project stream

-

Methods

getWorkTime

run

Settings

Member Visibility

Theme

On This Page

\ 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 e3fe5834..c809d876 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.126

Class JobRestoreStorage

Job restore

-

Hierarchy (view full)

Constructors

constructor +JobRestoreStorage | Firebase Engine - v1.5.127

Class JobRestoreStorage

Job restore

+

Hierarchy (view full)

Constructors

constructor

Properties

admin buckets counter @@ -12,22 +12,22 @@ writeStream

Methods

getWorkTime run -

Constructors

constructor

Properties

admin

admin: App

firebase app

-

Private buckets

buckets: string[]

Array of google storage bucket name

-

counter

counter: number = 0

operation counter

-

fileStream

fileStream: ReadStream

file read stream

-

Optional gunzipStream

gunzipStream?: Gunzip

unzip stream

-

parserStream

parserStream: Transform

string to object stream

-

settings

settings: Settings

settings object

-

startTimestamp

startTimestamp: number

start timestamp

-

store

store: Storage

Google cloud storage app

-

Private writeStream

writeStream: Writable

write file to project stream

-

Methods

getWorkTime

run

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/utils_AuthConverter.AuthConverter.html b/docs/classes/utils_AuthConverter.AuthConverter.html index 70e9134a..92c93857 100644 --- a/docs/classes/utils_AuthConverter.AuthConverter.html +++ b/docs/classes/utils_AuthConverter.AuthConverter.html @@ -1,16 +1,16 @@ -AuthConverter | Firebase Engine - v1.5.126

Class AuthConverter

Auth Document converter

-

Constructors

constructor +AuthConverter | Firebase Engine - v1.5.127

Class AuthConverter

Auth Document converter

+

Constructors

constructor

Properties

userField

Methods

fromString toString

Constructors

constructor

Properties

Static Private userField

userField: string[] = ...

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

-

Methods

Static fromString

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

  • Convert string to object

    -

    Parameters

    • d: string

      String to convert

      -
    • restorePassword: boolean = false

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

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

Static toString

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/utils_FirebaseAuth.Auth.html b/docs/classes/utils_FirebaseAuth.Auth.html index 64da9e36..5136e577 100644 --- a/docs/classes/utils_FirebaseAuth.Auth.html +++ b/docs/classes/utils_FirebaseAuth.Auth.html @@ -1,4 +1,4 @@ -Auth | Firebase Engine - v1.5.126

Class Auth

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

Class Auth

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

Hierarchy

  • BaseAuth
    • Auth

Constructors

constructor

Properties

app_ @@ -36,14 +36,14 @@ verifySessionCookie

Constructors

constructor

  • new Auth(): Auth

  • Returns Auth

Properties

Private Readonly app_

app_: any

Private Readonly projectConfigManager_

projectConfigManager_: any

Private Readonly tenantManager_

tenantManager_: any

Accessors

app

  • get app(): App

  • Returns the app associated with this Auth instance.

    Returns App

    The app associated with this Auth instance.

    -

Methods

_verifyAuthBlockingToken

  • _verifyAuthBlockingToken(token, audience?): Promise<DecodedAuthBlockingToken>
  • Alpha

    Parameters

    • token: string
    • Optional audience: string

    Returns Promise<DecodedAuthBlockingToken>

createCustomToken

  • createCustomToken(uid, developerClaims?): Promise<string>

  • Creates a new Firebase custom token (JWT) that can be sent back to a client +

Methods

_verifyAuthBlockingToken

  • _verifyAuthBlockingToken(token, audience?): Promise<DecodedAuthBlockingToken>
  • Alpha

    Parameters

    • token: string
    • Optional audience: string

    Returns Promise<DecodedAuthBlockingToken>

createCustomToken

  • createCustomToken(uid, developerClaims?): Promise<string>

  • Creates a new Firebase custom token (JWT) that can be sent back to a client device to use to sign in with the client SDKs' signInWithCustomToken() methods. (Tenant-aware instances will also embed the tenant ID in the token.)

    See Create Custom Tokens for code samples and detailed documentation.

    -

    Parameters

    • uid: string

      The uid to use as the custom token's subject.

      -
    • Optional developerClaims: object

      Optional additional claims to include +

      Parameters

      • uid: string

        The uid to use as the custom token's subject.

        +
      • Optional developerClaims: object

        Optional additional claims to include in the custom token's payload.

      Returns Promise<string>

      A promise fulfilled with a custom token for the provided uid and payload.

      @@ -52,7 +52,7 @@

      SAML and OIDC provider support requires Google Cloud's Identity Platform (GCIP). To learn more about GCIP, including pricing and features, see the GCIP documentation.

      -

    Parameters

    • config: AuthProviderConfig

      The provider configuration to create.

      +

      Parameters

      • config: AuthProviderConfig

        The provider configuration to create.

      Returns Promise<AuthProviderConfig>

      A promise that resolves with the created provider configuration.

createSessionCookie

  • createSessionCookie(idToken, sessionCookieOptions): Promise<string>

  • Creates a new Firebase session cookie with the specified options. The created JWT string can be set as a server-side session cookie with a custom cookie @@ -60,16 +60,16 @@ the same payload claims as the provided ID token.

    See Manage Session Cookies for code samples and detailed documentation.

    -

    Parameters

    • idToken: string

      The Firebase ID token to exchange for a session +

      Parameters

      • idToken: string

        The Firebase ID token to exchange for a session cookie.

        -
      • sessionCookieOptions: SessionCookieOptions

        The session +

      • sessionCookieOptions: SessionCookieOptions

        The session cookie options which includes custom session duration.

      Returns Promise<string>

      A promise that resolves on success with the created session cookie.

createUser

  • createUser(properties): Promise<UserRecord>

  • Creates a new user.

    See Create a user for code samples and detailed documentation.

    -

    Parameters

    • properties: CreateRequest

      The properties to set on the +

      Parameters

      • properties: CreateRequest

        The properties to set on the new user record to be created.

      Returns Promise<UserRecord>

      A promise fulfilled with the user data corresponding to the newly created user.

      @@ -79,13 +79,13 @@

      SAML and OIDC provider support requires Google Cloud's Identity Platform (GCIP). To learn more about GCIP, including pricing and features, see the GCIP documentation.

      -

    Parameters

    • providerId: string

      The provider ID corresponding to the provider +

      Parameters

      • providerId: string

        The provider ID corresponding to the provider config to delete.

      Returns Promise<void>

      A promise that resolves on completion.

deleteUser

  • deleteUser(uid): Promise<void>

  • Deletes an existing user.

    See Delete a user for code samples and detailed documentation.

    -

    Parameters

    • uid: string

      The uid corresponding to the user to delete.

      +

      Parameters

      • uid: string

        The uid corresponding to the user to delete.

      Returns Promise<void>

      An empty promise fulfilled once the user has been deleted.

deleteUsers

  • deleteUsers(uids): Promise<DeleteUsersResult>

  • Deletes the users specified by the given uids.

    @@ -99,7 +99,7 @@ this, you may get a quota exceeded error. Therefore, if you want to delete more than 1000 users, you may need to add a delay to ensure you don't go over this limit.

    -

    Parameters

    • uids: string[]

      The uids corresponding to the users to delete.

      +

      Parameters

      • uids: string[]

        The uids corresponding to the users to delete.

      Returns Promise<DeleteUsersResult>

      A Promise that resolves to the total number of successful/failed deletions, as well as the array of errors that corresponds to the failed deletions.

      @@ -108,8 +108,8 @@ as an argument to this method defines whether the link is to be handled by a mobile app or browser along with additional state information to be passed in the deep link, etc.

      -

    Parameters

    • email: string

      The email account to verify.

      -
    • Optional actionCodeSettings: ActionCodeSettings

      The action +

      Parameters

      • email: string

        The email account to verify.

        +
      • Optional actionCodeSettings: ActionCodeSettings

        The action code settings. If specified, the state/continue URL is set as the "continueUrl" parameter in the email verification link. The default email verification landing page will use this to display a link to go back to @@ -130,9 +130,9 @@ optional ActionCodeSettings object defines whether the link is to be handled by a mobile app or browser and the additional state information to be passed in the deep link, etc.

        -

        Parameters

        • email: string

          The email address of the user whose password is to be +

          Parameters

          • email: string

            The email address of the user whose password is to be reset.

            -
          • Optional actionCodeSettings: ActionCodeSettings

            The action +

          • Optional actionCodeSettings: ActionCodeSettings

            The action code settings. If specified, the state/continue URL is set as the "continueUrl" parameter in the password reset link. The default password reset landing page will use this to display a link to go back to the app @@ -153,8 +153,8 @@ as an argument to this method defines whether the link is to be handled by a mobile app or browser along with additional state information to be passed in the deep link, etc.

            -

            Parameters

            • email: string

              The email account to verify.

              -
            • actionCodeSettings: ActionCodeSettings

              The action +

              Parameters

              • email: string

                The email account to verify.

                +
              • actionCodeSettings: ActionCodeSettings

                The action code settings. If specified, the state/continue URL is set as the "continueUrl" parameter in the email verification link. The default email verification landing page will use this to display a link to go back to @@ -175,9 +175,9 @@ as an argument to this method defines whether the link is to be handled by a mobile app or browser along with additional state information to be passed in the deep link, etc.

                -

                Parameters

                • email: string

                  The current email account.

                  -
                • newEmail: string

                  The email address the account is being updated to.

                  -
                • Optional actionCodeSettings: ActionCodeSettings

                  The action +

                  Parameters

                  • email: string

                    The current email account.

                    +
                  • newEmail: string

                    The email address the account is being updated to.

                    +
                  • Optional actionCodeSettings: ActionCodeSettings

                    The action code settings. If specified, the state/continue URL is set as the "continueUrl" parameter in the email verification link. The default email verification landing page will use this to display a link to go back to @@ -198,20 +198,20 @@

                    SAML and OIDC provider support requires Google Cloud's Identity Platform (GCIP). To learn more about GCIP, including pricing and features, see the GCIP documentation.

                    -

                    Parameters

                    • providerId: string

                      The provider ID corresponding to the provider +

                      Parameters

                      • providerId: string

                        The provider ID corresponding to the provider config to return.

                      Returns Promise<AuthProviderConfig>

                      A promise that resolves with the configuration corresponding to the provided ID.

getUser

  • getUser(uid): Promise<UserRecord>

  • Gets the user data for the user corresponding to a given uid.

    See Retrieve user data for code samples and detailed documentation.

    -

    Parameters

    • uid: string

      The uid corresponding to the user whose data to fetch.

      +

      Parameters

      • uid: string

        The uid corresponding to the user whose data to fetch.

      Returns Promise<UserRecord>

      A promise fulfilled with the user data corresponding to the provided uid.

getUserByEmail

  • getUserByEmail(email): Promise<UserRecord>

  • Gets the user data for the user corresponding to a given email.

    See Retrieve user data for code samples and detailed documentation.

    -

    Parameters

    • email: string

      The email corresponding to the user whose data to +

      Parameters

      • email: string

        The email corresponding to the user whose data to fetch.

      Returns Promise<UserRecord>

      A promise fulfilled with the user data corresponding to the provided email.

      @@ -219,16 +219,16 @@ phone number has to conform to the E.164 specification.

      See Retrieve user data for code samples and detailed documentation.

      -

    Parameters

    • phoneNumber: string

      The phone number corresponding to the user whose +

      Parameters

      • phoneNumber: string

        The phone number corresponding to the user whose data to fetch.

      Returns Promise<UserRecord>

      A promise fulfilled with the user data corresponding to the provided phone number.

getUserByProviderUid

  • getUserByProviderUid(providerId, uid): Promise<UserRecord>

  • Gets the user data for the user corresponding to a given provider id.

    See Retrieve user data for code samples and detailed documentation.

    -

    Parameters

    • providerId: string

      The provider ID, for example, "google.com" for the +

      Parameters

      • providerId: string

        The provider ID, for example, "google.com" for the Google provider.

        -
      • uid: string

        The user identifier for the given provider.

        +
      • uid: string

        The user identifier for the given provider.

      Returns Promise<UserRecord>

      A promise fulfilled with the user data corresponding to the given provider id.

getUsers

  • getUsers(identifiers): Promise<GetUsersResult>

  • Gets the user data corresponding to the specified identifiers.

    @@ -236,7 +236,7 @@ guaranteed to correspond to the nth entry in the input parameters list.

    Only a maximum of 100 identifiers may be supplied. If more than 100 identifiers are supplied, this method throws a FirebaseAuthError.

    -

    Parameters

    • identifiers: UserIdentifier[]

      The identifiers used to indicate which user records should be returned. +

      Parameters

      • identifiers: UserIdentifier[]

        The identifiers used to indicate which user records should be returned. Must not have more than 100 entries.

      Returns Promise<GetUsersResult>

      A promise that resolves to the corresponding user records.

      Throws

      FirebaseAuthError If any of the identifiers are invalid or if more than 100 @@ -248,8 +248,8 @@ specified. This operation is optimized for bulk imports and will ignore checks on uid, email and other identifier uniqueness which could result in duplications.

      -

      Parameters

      • users: UserImportRecord[]

        The list of user records to import to Firebase Auth.

        -
      • Optional options: UserImportOptions

        The user import options, required when the users provided include +

        Parameters

        • users: UserImportRecord[]

          The list of user records to import to Firebase Auth.

          +
        • Optional options: UserImportOptions

          The user import options, required when the users provided include password credentials.

        Returns Promise<UserImportResult>

        A promise that resolves when the operation completes with the result of the import. This includes the @@ -260,7 +260,7 @@

        SAML and OIDC provider support requires Google Cloud's Identity Platform (GCIP). To learn more about GCIP, including pricing and features, see the GCIP documentation.

        -

      Parameters

      • options: AuthProviderConfigFilter

        The provider config filter to apply.

        +

        Parameters

        • options: AuthProviderConfigFilter

          The provider config filter to apply.

        Returns Promise<ListProviderConfigResults>

        A promise that resolves with the list of provider configs meeting the filter requirements.

listUsers

  • listUsers(maxResults?, pageToken?): Promise<ListUsersResult>

  • Retrieves a list of users (single batch only) with a size of maxResults @@ -268,9 +268,9 @@ retrieve all the users of a specified project in batches.

    See List all users for code samples and detailed documentation.

    -

    Parameters

    • Optional maxResults: number

      The page size, 1000 if undefined. This is also +

      Parameters

      • Optional maxResults: number

        The page size, 1000 if undefined. This is also the maximum allowed limit.

        -
      • Optional pageToken: string

        The next page token. If not specified, returns +

      • Optional pageToken: string

        The next page token. If not specified, returns users starting without any offset.

      Returns Promise<ListUsersResult>

      A promise that resolves with the current batch of downloaded users and the next page token.

      @@ -285,7 +285,7 @@ may remain active until their natural expiration (one hour). To verify that ID tokens are revoked, use BaseAuth.verifyIdToken where checkRevoked is set to true.

      -

    Parameters

    • uid: string

      The uid corresponding to the user whose refresh tokens +

      Parameters

      • uid: string

        The uid corresponding to the user whose refresh tokens are to be revoked.

      Returns Promise<void>

      An empty promise fulfilled once the user's refresh tokens have been revoked.

      @@ -298,8 +298,8 @@ authenticated user's ID token JWT.

      See Defining user roles and access levels for code samples and detailed documentation.

      -

    Parameters

    • uid: string

      The uid of the user to edit.

      -
    • customUserClaims: null | object

      The developer claims to set. If null is +

      Parameters

      • uid: string

        The uid of the user to edit.

        +
      • customUserClaims: null | object

        The developer claims to set. If null is passed, existing custom claims are deleted. Passing a custom claims payload larger than 1000 bytes will throw an error. Custom claims are added to the user's ID token which is transmitted on every authenticated request. @@ -316,15 +316,15 @@

        SAML and OIDC provider support requires Google Cloud's Identity Platform (GCIP). To learn more about GCIP, including pricing and features, see the GCIP documentation.

        -

        Parameters

        • providerId: string

          The provider ID corresponding to the provider +

          Parameters

          • providerId: string

            The provider ID corresponding to the provider config to update.

            -
          • updatedConfig: UpdateAuthProviderRequest

            The updated configuration.

            +
          • updatedConfig: UpdateAuthProviderRequest

            The updated configuration.

          Returns Promise<AuthProviderConfig>

          A promise that resolves with the updated provider configuration.

updateUser

  • updateUser(uid, properties): Promise<UserRecord>

  • Updates an existing user.

    See Update a user for code samples and detailed documentation.

    -

    Parameters

    • uid: string

      The uid corresponding to the user to update.

      -
    • properties: UpdateRequest

      The properties to update on +

      Parameters

      • uid: string

        The uid corresponding to the user to update.

        +
      • properties: UpdateRequest

        The properties to update on the provided user.

      Returns Promise<UserRecord>

      A promise fulfilled with the updated user data.

      @@ -338,8 +338,8 @@ error is thrown. If not specified the check is not applied.

      See Verify ID Tokens for code samples and detailed documentation.

      -

    Parameters

    • idToken: string

      The ID token to verify.

      -
    • Optional checkRevoked: boolean

      Whether to check if the ID token was revoked. +

      Parameters

      • idToken: string

        The ID token to verify.

        +
      • Optional checkRevoked: boolean

        Whether to check if the ID token was revoked. This requires an extra request to the Firebase Auth backend to check the tokensValidAfterTime time for the corresponding user. When not specified, this additional check is not applied.

        @@ -356,11 +356,11 @@ is not performed.

        See Verify Session Cookies for code samples and detailed documentation

        -

        Parameters

        • sessionCookie: string

          The session cookie to verify.

          -
        • Optional checkRevoked: boolean

        Returns Promise<DecodedIdToken>

        A promise fulfilled with the +

      Parameters

      • sessionCookie: string

        The session cookie to verify.

        +
      • Optional checkRevoked: boolean

      Returns Promise<DecodedIdToken>

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

      -

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/utils_FirebaseAuth.UserRecord.html b/docs/classes/utils_FirebaseAuth.UserRecord.html index d29743ce..446f29a3 100644 --- a/docs/classes/utils_FirebaseAuth.UserRecord.html +++ b/docs/classes/utils_FirebaseAuth.UserRecord.html @@ -1,4 +1,4 @@ -UserRecord | Firebase Engine - v1.5.126

Class UserRecord

Represents a user.

+UserRecord | Firebase Engine - v1.5.127

Class UserRecord

Represents a user.

Constructors

constructor

Properties

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

Readonly uid

uid: string

The user's uid.

Methods

toJSON

  • toJSON(): object

  • Returns a JSON-serializable representation of this object.

    Returns object

    A JSON-serializable representation of this object.

    -

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/utils_FirebaseFirestore.DocumentReference.html b/docs/classes/utils_FirebaseFirestore.DocumentReference.html index 4d1728ad..c54b3018 100644 --- a/docs/classes/utils_FirebaseFirestore.DocumentReference.html +++ b/docs/classes/utils_FirebaseFirestore.DocumentReference.html @@ -1,8 +1,8 @@ -DocumentReference | Firebase Engine - v1.5.126

Class DocumentReference<AppModelType, DbModelType>

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

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.

-

Type Parameters

Constructors

constructor +

Type Parameters

Constructors

constructor

Properties

firestore id parent @@ -17,7 +17,7 @@ set update withConverter -

Constructors

Private constructor

Properties

Readonly firestore

firestore: Firestore

The Firestore for the Firestore database (useful for performing +

Constructors

Private constructor

Properties

Readonly firestore

firestore: Firestore

The Firestore for the Firestore database (useful for performing transactions, etc.).

Readonly id

id: string

The identifier of the document within its collection.

Readonly parent

parent: CollectionReference<AppModelType, DbModelType>

A reference to the Collection to which this DocumentReference belongs.

@@ -25,45 +25,45 @@ to the root of the database).

Methods

collection

  • collection(collectionPath): CollectionReference<DocumentData, DocumentData>

  • Gets a CollectionReference instance that refers to the collection at the specified path.

    -

    Parameters

    • collectionPath: string

      A slash-separated path to a collection.

      +

      Parameters

      • collectionPath: string

        A slash-separated path to a collection.

      Returns CollectionReference<DocumentData, DocumentData>

      The CollectionReference instance.

create

  • create(data): Promise<WriteResult>

  • Creates a document referred to by this DocumentReference with the provided object values. The write fails if the document already exists

    -

    Parameters

    • data: WithFieldValue<AppModelType>

      The object data to serialize as the document.

      +

      Parameters

      • data: WithFieldValue<AppModelType>

        The object data to serialize as the document.

      Returns Promise<WriteResult>

      A Promise resolved with the write time of this create.

      Throws

      If the provided input is not a valid Firestore document or if the document already exists.

delete

  • delete(precondition?): Promise<WriteResult>

  • Deletes the document referred to by this DocumentReference.

    -

    Parameters

    • Optional precondition: Precondition

      A Precondition to enforce for this delete.

      +

      Parameters

      • Optional precondition: Precondition

        A Precondition to enforce for this delete.

      Returns Promise<WriteResult>

      A Promise resolved with the write time of this delete.

get

  • get(): Promise<DocumentSnapshot<AppModelType, DbModelType>>

  • Reads the document referred to by this DocumentReference.

    Returns Promise<DocumentSnapshot<AppModelType, DbModelType>>

    A Promise resolved with a DocumentSnapshot containing the current document contents.

isEqual

  • isEqual(other): boolean

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

    -

    Parameters

listCollections

  • listCollections(): Promise<CollectionReference<DocumentData, DocumentData>[]>

  • Fetches the subcollections that are direct children of this document.

    Returns Promise<CollectionReference<DocumentData, DocumentData>[]>

    A Promise that resolves with an array of CollectionReferences.

onSnapshot

  • onSnapshot(onNext, onError?): (() => void)

  • Attaches a listener for DocumentSnapshot events.

    -

    Parameters

    • onNext: ((snapshot) => void)

      A callback to be called every time a new DocumentSnapshot +

      Parameters

      • onNext: ((snapshot) => void)

        A callback to be called every time a new DocumentSnapshot is available.

        -
      • Optional onError: ((error) => void)

        A callback to be called if the listen fails or is +

      • Optional onError: ((error) => void)

        A callback to be called if the listen fails or is cancelled. No further callbacks will occur.

        -
          • (error): void

          • Parameters

            • error: Error

            Returns void

      Returns (() => void)

      An unsubscribe function that can be called to cancel +

      • (error): void

      • Parameters

        • error: Error

        Returns void

Returns (() => void)

An unsubscribe function that can be called to cancel the snapshot listener.

    • (): void

    • Returns void

set

  • set(data, options): Promise<WriteResult>

  • Writes to the document referred to by this DocumentReference. If the document does not yet exist, it will be created. If you pass SetOptions, the provided data can be merged into an existing document.

    -

    Parameters

    • data: PartialWithFieldValue<AppModelType>

      A map of the fields and values for the document.

      -
    • options: SetOptions

      An object to configure the set behavior.

      +

      Parameters

      • data: PartialWithFieldValue<AppModelType>

        A map of the fields and values for the document.

        +
      • options: SetOptions

        An object to configure the set behavior.

      Returns Promise<WriteResult>

      A Promise resolved with the write time of this set.

      Throws

      Error If the provided input is not a valid Firestore document.

      -
    • set(data): Promise<WriteResult>

    • Parameters

      Returns Promise<WriteResult>

update

  • update(data, precondition?): Promise<WriteResult>

  • Updates fields in the document referred to by this DocumentReference. +

  • set(data): Promise<WriteResult>

  • Parameters

    Returns Promise<WriteResult>

update

  • update(data, precondition?): Promise<WriteResult>

  • Updates fields in the document referred to by this DocumentReference. The update will fail if applied to a document that does not exist.

    Nested fields can be updated by providing dot-separated field path strings.

    -

    Parameters

    • data: UpdateData<DbModelType>

      An object containing the fields and values with which to +

      Parameters

      • data: UpdateData<DbModelType>

        An object containing the fields and values with which to update the document.

        -
      • Optional precondition: Precondition

        A Precondition to enforce on this update.

        +
      • Optional precondition: Precondition

        A Precondition to enforce on this update.

      Returns Promise<WriteResult>

      A Promise resolved with the write time of this update.

      Throws

      Error If the provided input is not valid Firestore data.

    • update(field, value, ...moreFieldsOrPrecondition): Promise<WriteResult>

    • Updates fields in the document referred to by this DocumentReference. @@ -72,9 +72,9 @@ strings or by providing FieldPath objects.

      A Precondition restricting this update can be specified as the last argument.

      -

      Parameters

      • field: string | FieldPath

        The first field to update.

        -
      • value: any

        The first value.

        -
      • Rest ...moreFieldsOrPrecondition: any[]

        An alternating list of field paths and +

        Parameters

        • field: string | FieldPath

          The first field to update.

          +
        • value: any

          The first value.

          +
        • Rest ...moreFieldsOrPrecondition: any[]

          An alternating list of field paths and values to update, optionally followed by a Precondition to enforce on this update.

        Returns Promise<WriteResult>

        A Promise resolved with the write time of this update.

        @@ -84,10 +84,10 @@ set(), get(), etc. on the returned DocumentReference instance, the provided converter will convert between Firestore data of type NewDbModelType and your custom type NewAppModelType.

        -

      Type Parameters

      Parameters

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/utils_FirebaseFirestore.Firestore.html b/docs/classes/utils_FirebaseFirestore.Firestore.html index 1a2969be..06e13788 100644 --- a/docs/classes/utils_FirebaseFirestore.Firestore.html +++ b/docs/classes/utils_FirebaseFirestore.Firestore.html @@ -1,4 +1,4 @@ -Firestore | Firebase Engine - v1.5.126

Class Firestore

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

Class Firestore

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

Constructors

constructor

Methods

batch @@ -13,43 +13,43 @@ runTransaction settings terminate -

Constructors

constructor

  • new Firestore(settings?): Firestore

  • Parameters

    • Optional settings: Settings

      Configuration object. See [Firestore Documentation] +

Constructors

constructor

Methods

batch

  • batch(): WriteBatch

  • Creates a write batch, used for performing multiple writes as a single atomic operation.

    Returns WriteBatch

bulkWriter

  • bulkWriter(options?): BulkWriter

  • Creates a [BulkWriter]BulkWriter, used for performing multiple writes in parallel. Gradually ramps up writes as specified by the 500/50/5 rule.

    -

    Parameters

    • Optional options: BulkWriterOptions

      An options object used to configure the throttling +

      Parameters

      • Optional options: BulkWriterOptions

        An options object used to configure the throttling behavior for the underlying BulkWriter.

      Returns BulkWriter

      See

      https://firebase.google.com/docs/firestore/best-practices#ramping_up_traffic

bundle

  • bundle(bundleId?): BundleBuilder

  • Creates a new BundleBuilder instance to package selected Firestore data into a bundle.

    -

    Parameters

    • Optional bundleId: string

      The ID of the bundle. When loaded on clients, client SDKs use this ID +

      Parameters

      • Optional bundleId: string

        The ID of the bundle. When loaded on clients, client SDKs use this ID and the timestamp associated with the bundle to tell if it has been loaded already. If not specified, a random identifier will be used.

      Returns BundleBuilder

      Example

      const bundle = firestore.bundle('data-bundle');
      const docSnapshot = await firestore.doc('abc/123').get();
      const querySnapshot = await firestore.collection('coll').get();

      const bundleBuffer = bundle.add(docSnapshot); // Add a document
                                 .add('coll-query', querySnapshot) // Add a named query.
                                 .build()
      // Save `bundleBuffer` to CDN or stream it to clients.

collection

  • collection(collectionPath): CollectionReference<DocumentData, DocumentData>

  • Gets a CollectionReference instance that refers to the collection at the specified path.

    -

    Parameters

    • collectionPath: string

      A slash-separated path to a collection.

      +

      Parameters

      • collectionPath: string

        A slash-separated path to a collection.

      Returns CollectionReference<DocumentData, DocumentData>

      The CollectionReference instance.

collectionGroup

  • collectionGroup(collectionId): CollectionGroup<DocumentData, DocumentData>

  • Creates and returns a new Query that includes all documents in the database that are contained in a collection or subcollection with the given collectionId.

    -

    Parameters

    • collectionId: string

      Identifies the collections to query over. Every +

      Parameters

      • collectionId: string

        Identifies the collections to query over. Every collection or subcollection with this ID as the last segment of its path will be included. Cannot contain a slash.

      Returns CollectionGroup<DocumentData, DocumentData>

      The created CollectionGroup.

doc

  • doc(documentPath): DocumentReference<DocumentData, DocumentData>

  • Gets a DocumentReference instance that refers to the document at the specified path.

    -

    Parameters

    • documentPath: string

      A slash-separated path to a document.

      +

      Parameters

      • documentPath: string

        A slash-separated path to a document.

      Returns DocumentReference<DocumentData, DocumentData>

      The DocumentReference instance.

getAll

  • getAll(...documentRefsOrReadOptions): Promise<DocumentSnapshot<DocumentData, DocumentData>[]>

  • Retrieves multiple documents from Firestore.

    The first argument is required and must be of type DocumentReference followed by any additional DocumentReference documents. If used, the optional ReadOptions must be the last argument.

    -

    Parameters

    • Rest ...documentRefsOrReadOptions: (DocumentReference<DocumentData, DocumentData> | ReadOptions)[]

      The DocumentReferences to receive, followed by an optional field +

      Parameters

      Returns Promise<DocumentSnapshot<DocumentData, DocumentData>[]>

      A Promise that resolves with an array of resulting document snapshots.

      @@ -65,8 +65,8 @@

      recursiveDelete() uses a BulkWriter instance with default settings to perform the deletes. To customize throttling rates or add success/error callbacks, pass in a custom BulkWriter instance.

      -

    Parameters

    • ref: DocumentReference<any, any> | CollectionReference<any, any>

      The reference of a document or collection to delete.

      -
    • Optional bulkWriter: BulkWriter

      A custom BulkWriter instance used to perform the +

      Parameters

      • ref: DocumentReference<any, any> | CollectionReference<any, any>

        The reference of a document or collection to delete.

        +
      • Optional bulkWriter: BulkWriter

        A custom BulkWriter instance used to perform the deletes.

      Returns Promise<void>

      A promise that resolves when all deletes have been performed. The promise is rejected if any of the deletes fail.

      @@ -93,9 +93,9 @@

      Transactions time out after 60 seconds if no documents are read. Transactions that are not committed within than 270 seconds are also aborted. Any remaining locks are released when a transaction times out.

      -

    Type Parameters

    • T

    Parameters

    • updateFunction: ((transaction) => Promise<T>)

      The function to execute within the transaction +

      Type Parameters

      • T

      Parameters

      • updateFunction: ((transaction) => Promise<T>)

        The function to execute within the transaction context.

        -
          • (transaction): Promise<T>

          • Parameters

            • transaction: Transaction

            Returns Promise<T>

      • Optional transactionOptions: ReadOnlyTransactionOptions | ReadWriteTransactionOptions

        Transaction options.

        +
          • (transaction): Promise<T>

          • Parameters

            • transaction: Transaction

            Returns Promise<T>

      • Optional transactionOptions: ReadOnlyTransactionOptions | ReadWriteTransactionOptions

        Transaction options.

      Returns Promise<T>

      If the transaction completed successfully or was explicitly aborted (by the updateFunction returning a failed Promise), the Promise returned by the updateFunction will be returned here. Else if the @@ -107,11 +107,11 @@

      If settings are provided via both settings() and the Firestore constructor, both settings objects are merged and any settings provided via settings() take precedence.

      -

    Parameters

    • settings: Settings

      The settings to use for all Firestore +

      Parameters

      • settings: Settings

        The settings to use for all Firestore operations.

      Returns void

terminate

  • terminate(): Promise<void>

  • Terminates the Firestore client and closes all open streams.

    Returns Promise<void>

    A Promise that resolves when the client is terminated.

    -

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/utils_FirebaseFirestore.GeoPoint.html b/docs/classes/utils_FirebaseFirestore.GeoPoint.html index 430a6074..aef75828 100644 --- a/docs/classes/utils_FirebaseFirestore.GeoPoint.html +++ b/docs/classes/utils_FirebaseFirestore.GeoPoint.html @@ -1,4 +1,4 @@ -GeoPoint | Firebase Engine - v1.5.126

Class GeoPoint

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

Class GeoPoint

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

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

@@ -8,12 +8,12 @@

Methods

isEqual

Constructors

constructor

  • new GeoPoint(latitude, longitude): GeoPoint

  • Creates a new immutable GeoPoint object with the provided latitude and longitude values.

    -

    Parameters

    • latitude: number

      The latitude as number between -90 and 90.

      -
    • longitude: number

      The longitude as number between -180 and 180.

      +

      Parameters

      • latitude: number

        The latitude as number between -90 and 90.

        +
      • longitude: number

        The longitude as number between -180 and 180.

      Returns GeoPoint

Properties

Readonly latitude

latitude: number

Readonly longitude

longitude: number

Methods

isEqual

  • isEqual(other): boolean

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

    -

    Parameters

    • other: GeoPoint

      The GeoPoint to compare against.

      +

      Parameters

      • other: GeoPoint

        The GeoPoint to compare against.

      Returns boolean

      true if this GeoPoint is equal to the provided one.

      -

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/utils_FirebaseFirestore.Timestamp.html b/docs/classes/utils_FirebaseFirestore.Timestamp.html index 675289ca..86c5c274 100644 --- a/docs/classes/utils_FirebaseFirestore.Timestamp.html +++ b/docs/classes/utils_FirebaseFirestore.Timestamp.html @@ -1,4 +1,4 @@ -Timestamp | Firebase Engine - v1.5.126

Class Timestamp

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

Class Timestamp

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

Constructors

constructor

  • new Timestamp(seconds, nanoseconds): Timestamp

  • Creates a new timestamp.

    -

    Parameters

    • seconds: number

      The number of seconds of UTC time since Unix epoch +

      Parameters

      • seconds: number

        The number of seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

        -
      • nanoseconds: number

        The non-negative fractions of a second at nanosecond +

      • nanoseconds: number

        The non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanoseconds values that count forward in time. Must be from 0 to 999,999,999 inclusive.

      Returns Timestamp

Properties

Readonly nanoseconds

nanoseconds: number

The non-negative fractions of a second at nanosecond resolution.

Readonly seconds

seconds: number

The number of seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z.

Methods

isEqual

  • isEqual(other): boolean

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

    -

    Parameters

    • other: Timestamp

      The Timestamp to compare against.

      +

      Parameters

      • other: Timestamp

        The Timestamp to compare against.

      Returns boolean

      'true' if this Timestamp is equal to the provided one.

toDate

  • toDate(): Date

  • Returns a new Date corresponding to this timestamp. This may lose precision.

    @@ -40,17 +40,17 @@ using the >, <=, >= and > operators.

    Returns string

    a string encoding of this object.

Static fromDate

  • fromDate(date): Timestamp

  • Creates a new timestamp from the given date.

    -

    Parameters

    • date: Date

      The date to initialize the Timestamp from.

      +

      Parameters

      • date: Date

        The date to initialize the Timestamp from.

      Returns Timestamp

      A new Timestamp representing the same point in time as the given date.

Static fromMillis

  • fromMillis(milliseconds): Timestamp

  • Creates a new timestamp from the given number of milliseconds.

    -

    Parameters

    • milliseconds: number

      Number of milliseconds since Unix epoch +

      Parameters

      • milliseconds: number

        Number of milliseconds since Unix epoch 1970-01-01T00:00:00Z.

      Returns Timestamp

      A new Timestamp representing the same point in time as the given number of milliseconds.

Static now

  • now(): Timestamp

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

    Returns Timestamp

    A new Timestamp representing the current date.

    -

Settings

Member Visibility

Theme

On This Page

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

Class WriteBatch

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

+WriteBatch | Firebase Engine - v1.5.127

Class WriteBatch

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

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

create

  • create<AppModelType, DbModelType>(documentRef, data): WriteBatch

  • Create the document referred to by the provided DocumentReference. The operation will fail the batch if a document exists at the specified location.

    -

    Type Parameters

    Parameters

    • documentRef: DocumentReference<AppModelType, DbModelType>

      A reference to the document to be created.

      -
    • data: WithFieldValue<AppModelType>

      The object data to serialize as the document.

      +

      Type Parameters

      Parameters

      Returns WriteBatch

      This WriteBatch instance. Used for chaining method calls.

      Throws

      Error If the provided input is not a valid Firestore document.

delete

  • delete(documentRef, precondition?): WriteBatch

  • Deletes the document referred to by the provided DocumentReference.

    -

    Parameters

    • documentRef: DocumentReference<any, any>

      A reference to the document to be deleted.

      -
    • Optional precondition: Precondition

      A Precondition to enforce for this delete.

      +

      Parameters

      • documentRef: DocumentReference<any, any>

        A reference to the document to be deleted.

        +
      • Optional precondition: Precondition

        A Precondition to enforce for this delete.

      Returns WriteBatch

      This WriteBatch instance. Used for chaining method calls.

set

  • set<AppModelType, DbModelType>(documentRef, data, options): WriteBatch

  • Write to the document referred to by the provided DocumentReference. If the document does not exist yet, it will be created. If you pass SetOptions, the provided data can be merged into the existing document.

    -

    Type Parameters

    Parameters

update

update

  • update<AppModelType, DbModelType>(documentRef, data, precondition?): WriteBatch

  • Update fields of the document referred to by the provided DocumentReference. If the document doesn't yet exist, the update fails and the entire batch will be rejected.

    Nested fields can be updated by providing dot-separated field path strings.

    -

    Type Parameters

    Parameters

    • documentRef: DocumentReference<AppModelType, DbModelType>

      A reference to the document to be updated.

      -
    • data: UpdateData<DbModelType>

      An object containing the fields and values with which to +

      Type Parameters

      Parameters

      • documentRef: DocumentReference<AppModelType, DbModelType>

        A reference to the document to be updated.

        +
      • data: UpdateData<DbModelType>

        An object containing the fields and values with which to update the document.

        -
      • Optional precondition: Precondition

        A Precondition to enforce on this update.

        +
      • Optional precondition: Precondition

        A Precondition to enforce on this update.

      Returns WriteBatch

      This WriteBatch instance. Used for chaining method calls.

      Throws

      Error If the provided input is not valid Firestore data.

    • update(documentRef, field, value, ...fieldsOrPrecondition): WriteBatch

    • Updates fields in the document referred to by the provided @@ -51,15 +51,15 @@ strings or by providing FieldPath objects.

      A Precondition restricting this update can be specified as the last argument.

      -

      Parameters

      • documentRef: DocumentReference<any, any>

        A reference to the document to be updated.

        -
      • field: string | FieldPath

        The first field to update.

        -
      • value: any

        The first value

        -
      • Rest ...fieldsOrPrecondition: any[]

        An alternating list of field paths and values +

        Parameters

        • documentRef: DocumentReference<any, any>

          A reference to the document to be updated.

          +
        • field: string | FieldPath

          The first field to update.

          +
        • value: any

          The first value

          +
        • Rest ...fieldsOrPrecondition: any[]

          An alternating list of field paths and values to update, optionally followed a Precondition to enforce on this update.

        Returns WriteBatch

        This WriteBatch instance. Used for chaining method calls.

        Throws

        Error If the provided input is not valid Firestore data.

        -

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/utils_FirebaseStorage.Storage.html b/docs/classes/utils_FirebaseStorage.Storage.html index 20c20b4e..36c059c5 100644 --- a/docs/classes/utils_FirebaseStorage.Storage.html +++ b/docs/classes/utils_FirebaseStorage.Storage.html @@ -1,4 +1,4 @@ -Storage | Firebase Engine - v1.5.126

Class Storage

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

Class Storage

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

Constructors

constructor @@ -9,11 +9,11 @@

Constructors

constructor

Properties

Private Readonly appInternal

appInternal: any

Private Readonly storageClient

storageClient: any

Accessors

app

  • get app(): App

  • Optional app whose Storage service to return. If not provided, the default Storage service will be returned.

    Returns App

Methods

bucket

  • bucket(name?): Bucket

  • Gets a reference to a Cloud Storage bucket.

    -

    Parameters

    • Optional name: string

      Optional name of the bucket to be retrieved. If name is not specified, +

      Parameters

      • Optional name: string

        Optional name of the bucket to be retrieved. If name is not specified, retrieves a reference to the default bucket.

      Returns Bucket

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

      -

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/utils_FirestoreConverter.FirestoreConverter.html b/docs/classes/utils_FirestoreConverter.FirestoreConverter.html index 3c915467..4138b813 100644 --- a/docs/classes/utils_FirestoreConverter.FirestoreConverter.html +++ b/docs/classes/utils_FirestoreConverter.FirestoreConverter.html @@ -1,18 +1,18 @@ -FirestoreConverter | Firebase Engine - v1.5.126

Class FirestoreConverter

Firestore Document converter

-

Constructors

constructor +FirestoreConverter | Firebase Engine - v1.5.127

Class FirestoreConverter

Firestore Document converter

+

Constructors

constructor

Methods

fromObject fromString toObject toString

Constructors

constructor

Methods

Static Private fromObject

Static fromString

Static Private toObject

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

  • Internal deserialization

    -

    Parameters

    • d: any

      Object for deserialization

      -

    Returns {
        data: any;
        type: string;
    }

    • data: any
    • type: string

Static toString

  • toString(d): string

  • Convert an object to a string

    -

    Parameters

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

      Object for convert

      -
      • [key: string]: any

    Returns string

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/utils_Logger.Logger.html b/docs/classes/utils_Logger.Logger.html index 662c3c73..f34662be 100644 --- a/docs/classes/utils_Logger.Logger.html +++ b/docs/classes/utils_Logger.Logger.html @@ -1,14 +1,14 @@ -Logger | Firebase Engine - v1.5.126

Class Logger

Logger class

-

Constructors

constructor +Logger | Firebase Engine - v1.5.127

Class Logger

Logger class

+

Constructors

constructor

Methods

error log table warn

Constructors

constructor

Methods

Static error

Static log

Static table

Static warn

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/utils_StorageConverter.StorageConverter.html b/docs/classes/utils_StorageConverter.StorageConverter.html index 288b61a9..2550745c 100644 --- a/docs/classes/utils_StorageConverter.StorageConverter.html +++ b/docs/classes/utils_StorageConverter.StorageConverter.html @@ -1,12 +1,12 @@ -StorageConverter | Firebase Engine - v1.5.126

Class StorageConverter

Storage File converter

-

Constructors

constructor +StorageConverter | Firebase Engine - v1.5.127

Class StorageConverter

Storage File converter

+

Constructors

constructor

Methods

fromString toString

Constructors

constructor

Methods

Static fromString

Static toString

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/utils_initialization.Writer.html b/docs/classes/utils_initialization.Writer.html index e130227c..20d4a1cd 100644 --- a/docs/classes/utils_initialization.Writer.html +++ b/docs/classes/utils_initialization.Writer.html @@ -1,13 +1,13 @@ -Writer | Firebase Engine - v1.5.126

Class Writer

Writer Class for create write streams

-

Constructors

constructor +Writer | Firebase Engine - v1.5.127

Class Writer

Writer Class for create write streams

+

Constructors

constructor

Properties

compress fileStream gzipStream? -

Constructors

constructor

Properties

compress

compress: boolean = false

use compress

-

fileStream

fileStream: WriteStream

file write stream after gzipped

-

Optional gzipStream

gzipStream?: Gzip

gzip stream

-

Settings

Member Visibility

Theme

On This Page

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

Class JobBackupServiceRestoreTemplate

Job restore

-

Hierarchy (view full)

Constructors

constructor +JobBackupServiceRestoreTemplate | Firebase Engine - v1.5.127

Class JobBackupServiceRestoreTemplate

Job restore

+

Hierarchy (view full)

Constructors

constructor

Properties

admin counter fileStream @@ -10,20 +10,20 @@ store

Methods

getWorkTime run -

Constructors

constructor

Properties

admin

admin: App

firebase app

-

counter

counter: number = 0

operation counter

-

fileStream

fileStream: ReadStream

file read stream

-

Optional gunzipStream

gunzipStream?: Gunzip

unzip stream

-

parserStream

parserStream: Transform

string to object stream

-

settings

settings: Settings

settings object

-

startTimestamp

startTimestamp: number

start timestamp

-

store

store: Storage

Google cloud storage app

-

Methods

getWorkTime

run

Settings

Member Visibility

Theme

On This Page

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

Class JobBackupServiceTemplate

Job backup

-

Hierarchy (view full)

Constructors

constructor +JobBackupServiceTemplate | Firebase Engine - v1.5.127

Class JobBackupServiceTemplate

Job backup

+

Hierarchy (view full)

Constructors

constructor

Properties

admin counter settings @@ -9,19 +9,19 @@ writer

Methods

getWorkTime run -

Constructors

constructor

Properties

admin

admin: App

firebase app

-

counter

counter: number = 0

operation counter

-

settings

settings: Settings

settings object

-

startTimestamp

startTimestamp: number

start timestamp

-

store

store: Storage

Google cloud storage app

-

stringiferStream

stringiferStream: Transform

object to string stream

-

writer

writer: Writer

Writer streams in object

-

Methods

getWorkTime

run

Settings

Member Visibility

Theme

On This Page

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

Class JobOneServiceTemplate

Job class

-

Hierarchy (view full)

Constructors

constructor +JobOneServiceTemplate | Firebase Engine - v1.5.127

Class JobOneServiceTemplate

Job class

+

Hierarchy (view full)

Constructors

constructor

Properties

admin counter settings @@ -7,17 +7,17 @@ store

Methods

getWorkTime run -

Constructors

constructor

Properties

admin

admin: App

firebase app

-

counter

counter: number = 0

operation counter

-

settings

settings: Settings

settings object

-

startTimestamp

startTimestamp: number

start timestamp

-

store

store: Storage

Google cloud storage app

-

Methods

getWorkTime

run

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/utils_template.JobOneTemplate.html b/docs/classes/utils_template.JobOneTemplate.html index 6c286f4f..615a894f 100644 --- a/docs/classes/utils_template.JobOneTemplate.html +++ b/docs/classes/utils_template.JobOneTemplate.html @@ -1,21 +1,21 @@ -JobOneTemplate | Firebase Engine - v1.5.126

Class JobOneTemplate

Job One Template Class

-

Hierarchy (view full)

Constructors

constructor +JobOneTemplate | Firebase Engine - v1.5.127

Class JobOneTemplate

Job One Template Class

+

Hierarchy (view full)

Constructors

constructor

Properties

admin settings store

Methods

auth firestore storage -

Constructors

constructor

Properties

admin

admin: App

firebase app

-

settings

settings: Settings

settings object

-

store

store: Storage

Google cloud storage app

-

Methods

auth

firestore

storage

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/utils_template.JobTemplate.html b/docs/classes/utils_template.JobTemplate.html index 35bcdc28..466df8f5 100644 --- a/docs/classes/utils_template.JobTemplate.html +++ b/docs/classes/utils_template.JobTemplate.html @@ -1,15 +1,15 @@ -JobTemplate | Firebase Engine - v1.5.126

Class JobTemplate

Job Template Class

-

Hierarchy (view full)

Constructors

constructor +JobTemplate | Firebase Engine - v1.5.127

Class JobTemplate

Job Template Class

+

Hierarchy (view full)

Constructors

constructor

Properties

admin settings store -

Constructors

constructor

Properties

admin

admin: App

firebase app

-

settings

settings: Settings

settings object

-

store

store: Storage

Google cloud storage app

-

Settings

Member Visibility

Theme

On This Page

\ 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 2f20cbdb..7292548d 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.126

Function applicationDefault

  • applicationDefault(httpAgent?): Credential

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

    Function applicationDefault

    • applicationDefault(httpAgent?): Credential

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

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

      See Initialize the SDK for more details.

      -

      Parameters

      • Optional httpAgent: Agent

        Optional HTTP Agent +

        Parameters

        • Optional httpAgent: Agent

          Optional HTTP Agent to be used when retrieving access tokens from Google token servers.

        Returns Credential

        A credential authenticated via Google Application Default Credentials that can be used to initialize an app.

        Example

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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/utils_FirebaseAdmin.credential.cert.html b/docs/functions/utils_FirebaseAdmin.credential.cert.html index 1080ca25..a3360dc7 100644 --- a/docs/functions/utils_FirebaseAdmin.credential.cert.html +++ b/docs/functions/utils_FirebaseAdmin.credential.cert.html @@ -1,12 +1,12 @@ -cert | Firebase Engine - v1.5.126

    Function cert

    • cert(serviceAccountPathOrObject, httpAgent?): Credential

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

      Function cert

      • cert(serviceAccountPathOrObject, httpAgent?): Credential

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

        See Initialize the SDK for more details.

        -

        Parameters

        • serviceAccountPathOrObject: string | ServiceAccount

          The path to a service +

          Parameters

          • serviceAccountPathOrObject: string | ServiceAccount

            The path to a service account key JSON file or an object representing a service account key.

            -
          • Optional httpAgent: Agent

            Optional HTTP Agent +

          • Optional httpAgent: Agent

            Optional HTTP Agent to be used when retrieving access tokens from Google token servers.

          Returns Credential

          A credential authenticated via the provided service account that can be used to initialize an app.

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

          Example

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

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/functions/utils_FirebaseAdmin.credential.refreshToken.html b/docs/functions/utils_FirebaseAdmin.credential.refreshToken.html index 4c0a228f..5c88d11c 100644 --- a/docs/functions/utils_FirebaseAdmin.credential.refreshToken.html +++ b/docs/functions/utils_FirebaseAdmin.credential.refreshToken.html @@ -1,19 +1,19 @@ -refreshToken | Firebase Engine - v1.5.126

      Function refreshToken

      • refreshToken(refreshTokenPathOrObject, httpAgent?): Credential

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

        Function refreshToken

        • refreshToken(refreshTokenPathOrObject, httpAgent?): Credential

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

          See Initialize the SDK for more details.

          -

          Parameters

          • refreshTokenPathOrObject: string | object

            The path to a Google +

            Parameters

            • refreshTokenPathOrObject: string | object

              The path to a Google OAuth2 refresh token JSON file or an object representing a Google OAuth2 refresh token.

              -
            • Optional httpAgent: Agent

              Optional HTTP Agent +

            • Optional httpAgent: Agent

              Optional HTTP Agent to be used when retrieving access tokens from Google token servers.

            Returns Credential

            A credential authenticated via the provided service account that can be used to initialize an app.

            Example

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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/docs/functions/utils_FirebaseAdmin.initializeApp.html b/docs/functions/utils_FirebaseAdmin.initializeApp.html index 516d587c..e731bbf5 100644 --- a/docs/functions/utils_FirebaseAdmin.initializeApp.html +++ b/docs/functions/utils_FirebaseAdmin.initializeApp.html @@ -1,4 +1,4 @@ -initializeApp | Firebase Engine - v1.5.126

        Function initializeApp

        • initializeApp(options?, appName?): App

        • Parameters

          • Optional options: AppOptions
          • Optional appName: string

          Returns App

        Settings

        Member Visibility

        Theme

        Function initializeApp

        • initializeApp(options?, appName?): App

        • Parameters

          • Optional options: AppOptions
          • Optional appName: string

          Returns App

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/docs/functions/utils_FirebaseAuth.getAuth.html b/docs/functions/utils_FirebaseAuth.getAuth.html index 3d6d0414..14885d8e 100644 --- a/docs/functions/utils_FirebaseAuth.getAuth.html +++ b/docs/functions/utils_FirebaseAuth.getAuth.html @@ -1,13 +1,13 @@ -getAuth | Firebase Engine - v1.5.126

        Function getAuth

        • getAuth(app?): Auth

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

          Function getAuth

          • getAuth(app?): Auth

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

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

            -

            Parameters

            • Optional app: App

            Returns Auth

            Example

            // Get the Auth service for the default app
            const defaultAuth = getAuth();
+

            Parameters

            • Optional app: App

            Returns Auth

            Example

            // Get the Auth service for the default app
            const defaultAuth = getAuth();

            Example

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

          Settings

          Member Visibility

          Theme

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

          Function getFirestore

          • getFirestore(): Firestore

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

            Function getFirestore

          • getFirestore(app): Firestore

          • Gets the default Firestore service for the given app.

            -

            Parameters

            • app: App

              which Firestore service to return.

              +

              Parameters

              • app: App

                which Firestore service to return.

              Returns Firestore

              The default Firestore service associated with the provided app.

              Example

              // Get the default Firestore service for a specific app
              const otherFirestore = getFirestore(app);
            • getFirestore(databaseId): Firestore
            • Beta

              Gets the named Firestore service for the default app.

              -

              Parameters

              • databaseId: string

                name of database to return.

                +

                Parameters

                • databaseId: string

                  name of database to return.

                Returns Firestore

                The named Firestore service for the default app.

                Example

                // Get the Firestore service for a named database and default app
                const otherFirestore = getFirestore('otherDb');
              • getFirestore(app, databaseId): Firestore
              • Beta

                Gets the named Firestore service for the given app.

                -

                Parameters

                • app: App

                  which Firestore service to return.

                  -
                • databaseId: string

                  name of database to return.

                  +

                  Parameters

                  • app: App

                    which Firestore service to return.

                    +
                  • databaseId: string

                    name of database to return.

                  Returns Firestore

                  The named Firestore service associated with the provided app.

                  Example

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

          Settings

          Member Visibility

          Theme

          \ No newline at end of file diff --git a/docs/functions/utils_FirebaseStorage.getStorage.html b/docs/functions/utils_FirebaseStorage.getStorage.html index 2ade65ae..8bfadaf2 100644 --- a/docs/functions/utils_FirebaseStorage.getStorage.html +++ b/docs/functions/utils_FirebaseStorage.getStorage.html @@ -1,12 +1,12 @@ -getStorage | Firebase Engine - v1.5.126

          Function getStorage

          • getStorage(app?): Storage

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

            +getStorage | Firebase Engine - v1.5.127

            Function getStorage

            • getStorage(app?): Storage

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

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

              -

              Parameters

              • Optional app: App

              Returns Storage

              Example

              // Get the Storage service for the default app
              const defaultStorage = getStorage();
+

              Parameters

              • Optional app: App

              Returns Storage

              Example

              // Get the Storage service for the default app
              const defaultStorage = getStorage();

              Example

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

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/functions/utils_initialization.cmdParser.html b/docs/functions/utils_initialization.cmdParser.html index 4a8f68e4..55c88165 100644 --- a/docs/functions/utils_initialization.cmdParser.html +++ b/docs/functions/utils_initialization.cmdParser.html @@ -1,5 +1,5 @@ -cmdParser | Firebase Engine - v1.5.126

            Function cmdParser

            Settings

            Member Visibility

            Theme

            Function cmdParser

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/functions/utils_initialization.createWriteFileStream.html b/docs/functions/utils_initialization.createWriteFileStream.html index 8c5739f6..51b21d72 100644 --- a/docs/functions/utils_initialization.createWriteFileStream.html +++ b/docs/functions/utils_initialization.createWriteFileStream.html @@ -1,6 +1,6 @@ -createWriteFileStream | Firebase Engine - v1.5.126

            Function createWriteFileStream

            Settings

            Member Visibility

            Theme

            Function createWriteFileStream

            Settings

            Member Visibility

            Theme

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

            Function initialization

            Settings

            Member Visibility

            Theme

            Function initialization

            Settings

            Member Visibility

            Theme

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

            Function randomStr

            • randomStr(length): string

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

              -

              Parameters

              • length: number

                code length

                -

              Returns string

            Settings

            Member Visibility

            Theme

            Function randomStr

            • randomStr(length): string

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

              +

              Parameters

              • length: number

                code length

                +

              Returns string

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 2674b44b..0f2e8e6f 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1,4 +1,4 @@ -Firebase Engine - v1.5.126

            Firebase Engine - v1.5.126

            Class Hierarchy

            Settings

            Member Visibility

            Theme

            Firebase Engine - v1.5.127

            Class Hierarchy

            Settings

            Member Visibility

            Theme

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

            Firebase Engine - v1.5.126

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

            Firebase Engine - v1.5.127

            firebase-engine

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

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

             firebase firestore:delete -r

            LICENSE

            Apache-2.0

            -

            Settings

            Member Visibility

            Theme

            On This Page

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

            Interface App

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

            Interface App

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

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

            Properties

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

            Example

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

            Example

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

            Settings

            Member Visibility

            Theme

            On This Page

            \ No newline at end of file diff --git a/docs/interfaces/utils_initialization.ParsedSettings.html b/docs/interfaces/utils_initialization.ParsedSettings.html index 498c9222..a8498ca7 100644 --- a/docs/interfaces/utils_initialization.ParsedSettings.html +++ b/docs/interfaces/utils_initialization.ParsedSettings.html @@ -1,5 +1,5 @@ -ParsedSettings | Firebase Engine - v1.5.126

            Interface ParsedSettings

            settings object from command line interface

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

            Properties

            backup? +ParsedSettings | Firebase Engine - v1.5.127

            Interface ParsedSettings

            settings object from command line interface

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

            Properties

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

            Properties

            Optional backup

            backup?: string

            path to backup file

            -

            buckets

            buckets: string[]

            buckets for processing

            -

            collections

            collections: string[]

            collections for processing

            -

            compress

            compress: boolean

            use compress

            -

            emulators

            emulators: boolean

            use emulators

            -

            hash_config

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

            password hash config

            -

            Type declaration

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

            operations

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

            array of operations

            -

            Optional path

            path?: string

            path to Firebase service account key (json)

            -

            services

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

            service for backup/clean/restore

            -

            Settings

            Member Visibility

            Theme

            On This Page

            \ No newline at end of file diff --git a/docs/interfaces/utils_initialization.Settings.html b/docs/interfaces/utils_initialization.Settings.html index 51c649e0..239f7c30 100644 --- a/docs/interfaces/utils_initialization.Settings.html +++ b/docs/interfaces/utils_initialization.Settings.html @@ -1,5 +1,5 @@ -Settings | Firebase Engine - v1.5.126

            Interface Settings

            settings object after initialization

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

            Properties

            backup +Settings | Firebase Engine - v1.5.127

            Interface Settings

            settings object after initialization

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

            Properties

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

            Properties

            backup

            backup: string

            path to backup file

            -

            buckets

            buckets: string[]

            buckets for processing

            -

            collections

            collections: string[]

            collections for processing

            -

            compress

            compress: boolean

            use compress

            -

            emulators

            emulators: boolean

            use emulators

            -

            Optional hash_config

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

            password hash config

            -

            Type declaration

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

            path

            path: string

            path to Firebase service account key (json)

            -

            serviceAccount

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

            Firebase service account key (object)

            -

            Type declaration

            • [key: string]: any

            Settings

            Member Visibility

            Theme

            On This Page

            \ No newline at end of file diff --git a/docs/interfaces/utils_initialization.SettingsBeforeInitialization.html b/docs/interfaces/utils_initialization.SettingsBeforeInitialization.html index 13ff3b59..5c84ce3a 100644 --- a/docs/interfaces/utils_initialization.SettingsBeforeInitialization.html +++ b/docs/interfaces/utils_initialization.SettingsBeforeInitialization.html @@ -1,5 +1,5 @@ -SettingsBeforeInitialization | Firebase Engine - v1.5.126

            Interface SettingsBeforeInitialization

            settings object before initialization

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

            Properties

            backup? +SettingsBeforeInitialization | Firebase Engine - v1.5.127

            Interface SettingsBeforeInitialization

            settings object before initialization

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

            Properties

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

            Properties

            Optional backup

            backup?: string

            path to backup file

            -

            Optional buckets

            buckets?: string[]

            buckets for processing

            -

            Optional collections

            collections?: string[]

            collections for processing

            -

            Optional compress

            compress?: boolean

            use compress

            -

            Optional emulators

            emulators?: boolean

            use emulators

            -

            Optional hash_config

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

            password hash config

            -

            Type declaration

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

            Optional path

            path?: string

            path to Firebase service account key (json)

            -

            Settings

            Member Visibility

            Theme

            On This Page

            \ No newline at end of file diff --git a/docs/interfaces/utils_template.DataModel.html b/docs/interfaces/utils_template.DataModel.html index 30a72922..bc329928 100644 --- a/docs/interfaces/utils_template.DataModel.html +++ b/docs/interfaces/utils_template.DataModel.html @@ -1,11 +1,11 @@ -DataModel | Firebase Engine - v1.5.126

            Interface DataModel

            Data Model

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

            Properties

            data +DataModel | Firebase Engine - v1.5.127

            Interface DataModel

            Data Model

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

            Properties

            data path service

            Properties

            data

            data: string

            document data

            -

            path

            path: string

            document path

            -

            service

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

            service type

            -

            Settings

            Member Visibility

            Theme

            On This Page

            \ No newline at end of file diff --git a/docs/modules/FirebaseEngine.html b/docs/modules/FirebaseEngine.html index f199cac4..21745c54 100644 --- a/docs/modules/FirebaseEngine.html +++ b/docs/modules/FirebaseEngine.html @@ -1,5 +1,5 @@ -FirebaseEngine | Firebase Engine - v1.5.126

            Module FirebaseEngine

            Index

            Classes

            FirebaseEngine -

            Settings

            Member Visibility

            Theme

            Module FirebaseEngine

            Index

            Classes

            FirebaseEngine +

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/modules/bin_firebase_engine.html b/docs/modules/bin_firebase_engine.html index 744440f5..bac275a4 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.126

            Module bin/firebase-engine

            Settings

            Member Visibility

            Theme

            Module bin/firebase-engine

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/modules/bin_firebase_engine_emulators.html b/docs/modules/bin_firebase_engine_emulators.html index eb10813c..6641d51e 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.126

            Module bin/firebase-engine-emulators

            Settings

            Member Visibility

            Theme

            Module bin/firebase-engine-emulators

            Settings

            Member Visibility

            Theme

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

            Module index

            Settings

            Member Visibility

            Theme

            Module index

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/modules/jobs_Jobs.html b/docs/modules/jobs_Jobs.html index 7c705641..b1da7c68 100644 --- a/docs/modules/jobs_Jobs.html +++ b/docs/modules/jobs_Jobs.html @@ -1,5 +1,5 @@ -jobs/Jobs | Firebase Engine - v1.5.126

            Module jobs/Jobs

            Index

            Classes

            Jobs -

            Settings

            Member Visibility

            Theme

            Module jobs/Jobs

            Index

            Classes

            Jobs +

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/modules/jobs_backup_auth.html b/docs/modules/jobs_backup_auth.html index 1eb5a86a..1d50868d 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.126

            Module jobs/backup/auth

            Index

            Classes

            JobBackupAuth -

            Settings

            Member Visibility

            Theme

            Module jobs/backup/auth

            Index

            Classes

            JobBackupAuth +

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/modules/jobs_backup_firestore.html b/docs/modules/jobs_backup_firestore.html index 71455e53..d8b16bab 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.126

            Module jobs/backup/firestore

            Index

            Classes

            JobBackupFirestore -

            Settings

            Member Visibility

            Theme

            Module jobs/backup/firestore

            Index

            Classes

            JobBackupFirestore +

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/modules/jobs_backup_storage.html b/docs/modules/jobs_backup_storage.html index 0b39614e..3c568076 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.126

            Module jobs/backup/storage

            Index

            Classes

            JobBackupStorage -

            Settings

            Member Visibility

            Theme

            Module jobs/backup/storage

            Index

            Classes

            JobBackupStorage +

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/modules/jobs_clean_auth.html b/docs/modules/jobs_clean_auth.html index fa7bd1d2..2171d9c5 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.126

            Module jobs/clean/auth

            Index

            Classes

            JobCleanAuth -

            Settings

            Member Visibility

            Theme

            Module jobs/clean/auth

            Index

            Classes

            JobCleanAuth +

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/modules/jobs_clean_firestore.html b/docs/modules/jobs_clean_firestore.html index 340467c9..74aed3b0 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.126

            Module jobs/clean/firestore

            Index

            Classes

            JobCleanFirestore -

            Settings

            Member Visibility

            Theme

            Module jobs/clean/firestore

            Index

            Classes

            JobCleanFirestore +

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/modules/jobs_clean_storage.html b/docs/modules/jobs_clean_storage.html index 797d1508..f638b7de 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.126

            Module jobs/clean/storage

            Index

            Classes

            JobCleanStorage -

            Settings

            Member Visibility

            Theme

            Module jobs/clean/storage

            Index

            Classes

            JobCleanStorage +

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/modules/jobs_restore_auth.html b/docs/modules/jobs_restore_auth.html index b0ed27dd..4eb8c6f4 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.126

            Module jobs/restore/auth

            Index

            Classes

            JobRestoreAuth -

            Settings

            Member Visibility

            Theme

            Module jobs/restore/auth

            Index

            Classes

            JobRestoreAuth +

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/modules/jobs_restore_firestore.html b/docs/modules/jobs_restore_firestore.html index 418c9b74..b5da8b1e 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.126

            Module jobs/restore/firestore

            Index

            Classes

            JobRestoreFirestore -

            Settings

            Member Visibility

            Theme

            Module jobs/restore/firestore

            Index

            Classes

            JobRestoreFirestore +

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/modules/jobs_restore_storage.html b/docs/modules/jobs_restore_storage.html index 0ee90f9d..a3757639 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.126

            Module jobs/restore/storage

            Index

            Classes

            JobRestoreStorage -

            Settings

            Member Visibility

            Theme

            Module jobs/restore/storage

            Index

            Classes

            JobRestoreStorage +

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/modules/utils_AuthConverter.html b/docs/modules/utils_AuthConverter.html index 96bcf238..2af796c1 100644 --- a/docs/modules/utils_AuthConverter.html +++ b/docs/modules/utils_AuthConverter.html @@ -1,5 +1,5 @@ -utils/AuthConverter | Firebase Engine - v1.5.126

            Module utils/AuthConverter

            Index

            Classes

            AuthConverter -

            Settings

            Member Visibility

            Theme

            Module utils/AuthConverter

            Index

            Classes

            AuthConverter +

            Settings

            Member Visibility

            Theme

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

            Namespace credential

            Index

            Type Aliases

            Credential +credential | Firebase Engine - v1.5.127

            Namespace credential

            Index

            Type Aliases

            Credential

            Functions

            applicationDefault cert refreshToken -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/modules/utils_FirebaseAdmin.html b/docs/modules/utils_FirebaseAdmin.html index c1d230c8..6112cab9 100644 --- a/docs/modules/utils_FirebaseAdmin.html +++ b/docs/modules/utils_FirebaseAdmin.html @@ -1,8 +1,8 @@ -utils/FirebaseAdmin | Firebase Engine - v1.5.126

            Module utils/FirebaseAdmin

            Index

            Namespaces

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

            Module utils/FirebaseAdmin

            Index

            Namespaces

            credential

            Interfaces

            App

            Variables

            apps

            Functions

            initializeApp -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/modules/utils_FirebaseAuth.html b/docs/modules/utils_FirebaseAuth.html index 808ae74b..cfc39912 100644 --- a/docs/modules/utils_FirebaseAuth.html +++ b/docs/modules/utils_FirebaseAuth.html @@ -1,8 +1,8 @@ -utils/FirebaseAuth | Firebase Engine - v1.5.126

            Module utils/FirebaseAuth

            Index

            Classes

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

            Module utils/FirebaseAuth

            Index

            Classes

            Auth UserRecord

            Type Aliases

            HashAlgorithmType

            Functions

            getAuth -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/modules/utils_FirebaseFirestore.html b/docs/modules/utils_FirebaseFirestore.html index 3d292cda..5dc93812 100644 --- a/docs/modules/utils_FirebaseFirestore.html +++ b/docs/modules/utils_FirebaseFirestore.html @@ -1,11 +1,11 @@ -utils/FirebaseFirestore | Firebase Engine - v1.5.126

            Module utils/FirebaseFirestore

            Index

            Classes

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

            Module utils/FirebaseFirestore

            Index

            Classes

            DocumentReference Firestore GeoPoint Timestamp WriteBatch

            Type Aliases

            DocumentData

            Functions

            getFirestore -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/modules/utils_FirebaseStorage.html b/docs/modules/utils_FirebaseStorage.html index 5917f393..61345bff 100644 --- a/docs/modules/utils_FirebaseStorage.html +++ b/docs/modules/utils_FirebaseStorage.html @@ -1,6 +1,6 @@ -utils/FirebaseStorage | Firebase Engine - v1.5.126

            Module utils/FirebaseStorage

            Index

            Classes

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

            Module utils/FirebaseStorage

            Index

            Classes

            Storage

            Functions

            getStorage -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/modules/utils_FirestoreConverter.html b/docs/modules/utils_FirestoreConverter.html index 54bfc404..f93a52b7 100644 --- a/docs/modules/utils_FirestoreConverter.html +++ b/docs/modules/utils_FirestoreConverter.html @@ -1,5 +1,5 @@ -utils/FirestoreConverter | Firebase Engine - v1.5.126

            Module utils/FirestoreConverter

            Index

            Classes

            FirestoreConverter -

            Settings

            Member Visibility

            Theme

            Module utils/FirestoreConverter

            Index

            Classes

            FirestoreConverter +

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/modules/utils_Logger.html b/docs/modules/utils_Logger.html index 6c9ac485..9e556904 100644 --- a/docs/modules/utils_Logger.html +++ b/docs/modules/utils_Logger.html @@ -1,5 +1,5 @@ -utils/Logger | Firebase Engine - v1.5.126

            Module utils/Logger

            Index

            Classes

            Logger -

            Settings

            Member Visibility

            Theme

            Module utils/Logger

            Index

            Classes

            Logger +

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/modules/utils_StorageConverter.html b/docs/modules/utils_StorageConverter.html index 8b564b20..cc261cdc 100644 --- a/docs/modules/utils_StorageConverter.html +++ b/docs/modules/utils_StorageConverter.html @@ -1,5 +1,5 @@ -utils/StorageConverter | Firebase Engine - v1.5.126

            Module utils/StorageConverter

            Index

            Classes

            StorageConverter -

            Settings

            Member Visibility

            Theme

            Module utils/StorageConverter

            Index

            Classes

            StorageConverter +

            Settings

            Member Visibility

            Theme

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

            Module utils/initialization

            Index

            Classes

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

            Module utils/initialization

            Index

            Classes

            Writer

            Interfaces

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

            Functions

            cmdParser createWriteFileStream initialization -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/modules/utils_randomStr.html b/docs/modules/utils_randomStr.html index b4fbed78..3fe835d1 100644 --- a/docs/modules/utils_randomStr.html +++ b/docs/modules/utils_randomStr.html @@ -1,5 +1,5 @@ -utils/randomStr | Firebase Engine - v1.5.126

            Module utils/randomStr

            Index

            Functions

            randomStr -

            Settings

            Member Visibility

            Theme

            Module utils/randomStr

            Index

            Functions

            randomStr +

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/modules/utils_template.html b/docs/modules/utils_template.html index b35fe7b9..7286ed66 100644 --- a/docs/modules/utils_template.html +++ b/docs/modules/utils_template.html @@ -1,10 +1,10 @@ -utils/template | Firebase Engine - v1.5.126

            Module utils/template

            Index

            Classes

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

            Module utils/template

            Index

            Classes

            JobBackupServiceRestoreTemplate JobBackupServiceTemplate JobOneServiceTemplate JobOneTemplate JobTemplate

            Interfaces

            DataModel -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/utils_FirebaseAdmin.credential.Credential.html b/docs/types/utils_FirebaseAdmin.credential.Credential.html index 2bc9e9a7..ea8709a9 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.126

            Type alias Credential

            Credential: TCredential

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

            Type alias Credential

            Credential: TCredential

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

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

            -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/utils_FirebaseAuth.HashAlgorithmType.html b/docs/types/utils_FirebaseAuth.HashAlgorithmType.html index 763825ec..d8cfee90 100644 --- a/docs/types/utils_FirebaseAuth.HashAlgorithmType.html +++ b/docs/types/utils_FirebaseAuth.HashAlgorithmType.html @@ -1,4 +1,4 @@ -HashAlgorithmType | Firebase Engine - v1.5.126

            Type alias HashAlgorithmType

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

            Settings

            Member Visibility

            Theme

            Type alias HashAlgorithmType

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

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/types/utils_FirebaseFirestore.DocumentData.html b/docs/types/utils_FirebaseFirestore.DocumentData.html index 8ddb704d..c46d68be 100644 --- a/docs/types/utils_FirebaseFirestore.DocumentData.html +++ b/docs/types/utils_FirebaseFirestore.DocumentData.html @@ -1,6 +1,6 @@ -DocumentData | Firebase Engine - v1.5.126

            Type alias DocumentData

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

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

            Type alias DocumentData

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

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

            -

            Type declaration

            • [field: string]: DocumentFieldValue

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/docs/variables/utils_FirebaseAdmin.apps.html b/docs/variables/utils_FirebaseAdmin.apps.html index 808638db..5a62ac6b 100644 --- a/docs/variables/utils_FirebaseAdmin.apps.html +++ b/docs/variables/utils_FirebaseAdmin.apps.html @@ -1,4 +1,4 @@ -apps | Firebase Engine - v1.5.126

            Variable appsConst

            apps: (app.App | null)[]

            Settings

            Member Visibility

            Theme

            Variable appsConst

            apps: (app.App | null)[]

            Settings

            Member Visibility

            Theme

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

            Variable writersConst

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

            write streams

            -

            Type declaration

            Settings

            Member Visibility

            Theme

            Variable writersConst

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

            write streams

            +

            Type declaration

            Settings

            Member Visibility

            Theme

            \ No newline at end of file