diff --git a/docs/classes/FirebaseEngine.FirebaseEngine.html b/docs/classes/FirebaseEngine.FirebaseEngine.html index 30373e9d..1f265f8f 100644 --- a/docs/classes/FirebaseEngine.FirebaseEngine.html +++ b/docs/classes/FirebaseEngine.FirebaseEngine.html @@ -1,4 +1,4 @@ -FirebaseEngine | Firebase Engine - v1.5.97
+FirebaseEngine | Firebase Engine - v1.5.98
  • Preparing search index...
    • -
  • The search index is not available
Firebase Engine - v1.5.97
+
  • The search index is not available
    • Firebase Engine - v1.5.98
    @@ -25,7 +25,7 @@

    Hierarchy

    • FirebaseEngine
    +
  • Defined in src/FirebaseEngine.ts:14
    • @@ -64,7 +64,7 @@
    settings: Returns FirebaseEngine
    +
  • Defined in src/FirebaseEngine.ts:18

    • Properties

    @@ -74,7 +74,7 @@

    Private

    +
  • Defined in src/FirebaseEngine.ts:32

    • jobs

    jobs: Jobs
    @@ -82,7 +82,7 @@

    jobs

    +
  • Defined in src/FirebaseEngine.ts:36

    • Private settings

    settings: Settings
    @@ -90,7 +90,7 @@

    Private

    +
  • Defined in src/FirebaseEngine.ts:28

    • Private store

    store: Storage
    @@ -98,7 +98,7 @@

    Private

    +
  • Defined in src/FirebaseEngine.ts:40

    • Methods

    @@ -111,7 +111,7 @@

    exitReturns Promise<void>

    +
  • Defined in src/FirebaseEngine.ts:44
    • @@ -138,7 +138,7 @@

    store
  • exit

    • -
    @@ -27,7 +27,7 @@

    Hierarchy

    +
  • Defined in src/jobs/Jobs.ts:18
    • @@ -75,7 +75,7 @@

    Returns

    +
  • Defined in src/jobs/Jobs.ts:24

    • Properties

    @@ -86,7 +86,7 @@

    admin

    +
  • Defined in src/utils/template.ts:31

    • backup

    backup: JobsBackup
    @@ -94,7 +94,7 @@

    backup

    +
  • Defined in src/jobs/Jobs.ts:33

    • clean

    clean: JobsClean
    @@ -102,7 +102,7 @@

    clean

    +
  • Defined in src/jobs/Jobs.ts:37

    • restore

    restore: JobsRestore
    @@ -110,7 +110,7 @@

    restore

    +
  • Defined in src/jobs/Jobs.ts:41

    • settings

    settings: Settings
    @@ -119,7 +119,7 @@

    settings

    +
  • Defined in src/utils/template.ts:27

    • store

    store: Storage
    @@ -128,7 +128,7 @@

    store

    +
  • Defined in src/utils/template.ts:35
    • @@ -156,7 +156,7 @@

    settings
  • store

    • -
    @@ -27,7 +27,7 @@

    Hierarchy

    +
  • Defined in src/jobs/backup/auth.ts:11
    • @@ -83,7 +83,7 @@

    Returns

    +
  • Defined in src/jobs/backup/auth.ts:17

    • Properties

    @@ -94,7 +94,7 @@

    admin

    +
  • Defined in src/utils/template.ts:31

    • Private auth

    auth: Auth
    @@ -102,7 +102,7 @@

    Private

    +
  • Defined in src/jobs/backup/auth.ts:24

    • counter

    counter: number = 0
    @@ -111,7 +111,7 @@

    counter

    +
  • Defined in src/utils/template.ts:89

    • settings

    settings: Settings
    @@ -120,7 +120,7 @@

    settings

    +
  • Defined in src/utils/template.ts:27

    • startTimestamp

    startTimestamp: number
    @@ -129,7 +129,7 @@

    startTimestamp

    +
  • Defined in src/utils/template.ts:102

    • store

    store: Storage
    @@ -138,7 +138,7 @@

    store

    +
  • Defined in src/utils/template.ts:35

    • stringiferStream

    stringiferStream: Transform
    @@ -147,7 +147,7 @@

    stringiferStream

    +
  • Defined in src/utils/template.ts:139

    • writer

    writer: Writer
    @@ -156,7 +156,7 @@

    writer

    +
  • Defined in src/utils/template.ts:135

    • Methods

    @@ -170,7 +170,7 @@

    Returns string

    +
  • Defined in src/utils/template.ts:93

    • Private recursiveBackup

    +
  • Defined in src/jobs/backup/auth.ts:28

    • run

    +
  • Defined in src/jobs/backup/auth.ts:65
    • @@ -231,7 +231,7 @@

    recursiveBackup
  • run

    • -
    @@ -27,7 +27,7 @@

    Hierarchy

    +
  • Defined in src/jobs/backup/firestore.ts:16
    • @@ -84,7 +84,7 @@

    Returns

    +
  • Defined in src/jobs/backup/firestore.ts:22

    • Properties

    @@ -95,7 +95,7 @@

    admin

    +
  • Defined in src/utils/template.ts:31

    • counter

    counter: number = 0
    @@ -104,7 +104,7 @@

    counter

    +
  • Defined in src/utils/template.ts:89

    • Private firestore

    firestore: Firestore
    @@ -112,7 +112,7 @@

    Private

    +
  • Defined in src/jobs/backup/firestore.ts:34

    • settings

    settings: Settings
    @@ -121,7 +121,7 @@

    settings

    +
  • Defined in src/utils/template.ts:27

    • startTimestamp

    startTimestamp: number
    @@ -130,7 +130,7 @@

    startTimestamp

    +
  • Defined in src/utils/template.ts:102

    • store

    store: Storage
    @@ -139,7 +139,7 @@

    store

    +
  • Defined in src/utils/template.ts:35

    • stringiferStream

    stringiferStream: Transform
    @@ -148,7 +148,7 @@

    stringiferStream

    +
  • Defined in src/utils/template.ts:139

    • writer

    writer: Writer
    @@ -157,7 +157,7 @@

    writer

    +
  • Defined in src/utils/template.ts:135

    • Methods

    @@ -175,7 +175,7 @@
    docSnap: Returns Promise<void>
    +
  • Defined in src/jobs/backup/firestore.ts:38

    • getWorkTime

    +
  • Defined in src/utils/template.ts:93

    • Private recursiveBackup

    +
  • Defined in src/jobs/backup/firestore.ts:73

    • run

    +
  • Defined in src/jobs/backup/firestore.ts:114
    • @@ -249,7 +249,7 @@

    recursiveBackup
  • run

    • -
    @@ -27,7 +27,7 @@

    Hierarchy

    +
  • Defined in src/jobs/backup/storage.ts:10
    • @@ -82,7 +82,7 @@

    Returns

    +
  • Defined in src/jobs/backup/storage.ts:16

    • Properties

    @@ -93,7 +93,7 @@

    admin

    +
  • Defined in src/utils/template.ts:31

    • counter

    counter: number = 0
    @@ -102,7 +102,7 @@

    counter

    +
  • Defined in src/utils/template.ts:89

    • settings

    settings: Settings
    @@ -111,7 +111,7 @@

    settings

    +
  • Defined in src/utils/template.ts:27

    • startTimestamp

    startTimestamp: number
    @@ -120,7 +120,7 @@

    startTimestamp

    +
  • Defined in src/utils/template.ts:102

    • store

    store: Storage
    @@ -129,7 +129,7 @@

    store

    +
  • Defined in src/utils/template.ts:35

    • stringiferStream

    stringiferStream: Transform
    @@ -138,7 +138,7 @@

    stringiferStream

    +
  • Defined in src/utils/template.ts:139

    • writer

    writer: Writer
    @@ -147,7 +147,7 @@

    writer

    +
  • Defined in src/utils/template.ts:135

    • Methods

    @@ -167,7 +167,7 @@
    file: Returns Promise<void>
    +
  • Defined in src/jobs/backup/storage.ts:22

    • getWorkTime

    +
  • Defined in src/utils/template.ts:93

    • run

    +
  • Defined in src/jobs/backup/storage.ts:61
    • @@ -223,7 +223,7 @@

    getWorkTime
  • run

    • -
    @@ -27,7 +27,7 @@

    Hierarchy

    +
  • Defined in src/jobs/clean/auth.ts:8
    • @@ -81,7 +81,7 @@

    Returns

    +
  • Defined in src/jobs/clean/auth.ts:14

    • Properties

    @@ -92,7 +92,7 @@

    admin

    +
  • Defined in src/utils/template.ts:31

    • Private auth

    auth: Auth
    @@ -100,7 +100,7 @@

    Private

    +
  • Defined in src/jobs/clean/auth.ts:21

    • counter

    counter: number = 0
    @@ -109,7 +109,7 @@

    counter

    +
  • Defined in src/utils/template.ts:89

    • settings

    settings: Settings
    @@ -118,7 +118,7 @@

    settings

    +
  • Defined in src/utils/template.ts:27

    • startTimestamp

    startTimestamp: number
    @@ -127,7 +127,7 @@

    startTimestamp

    +
  • Defined in src/utils/template.ts:102

    • store

    store: Storage
    @@ -136,7 +136,7 @@

    store

    +
  • Defined in src/utils/template.ts:35

    • Methods

    @@ -150,7 +150,7 @@

    Returns string

    +
  • Defined in src/utils/template.ts:93

    • Private recursiveClean

    +
  • Defined in src/jobs/clean/auth.ts:25

    • run

    +
  • Defined in src/jobs/clean/auth.ts:46
    • @@ -209,7 +209,7 @@

    recursiveClean
  • run

    • -
    @@ -27,7 +27,7 @@

    Hierarchy

    +
  • Defined in src/jobs/clean/firestore.ts:13
    • @@ -84,7 +84,7 @@

    Returns

    +
  • Defined in src/jobs/clean/firestore.ts:19

    • Properties

    @@ -95,7 +95,7 @@

    admin

    +
  • Defined in src/utils/template.ts:31

    • Private batch

    batch: WriteBatch
    @@ -103,7 +103,7 @@

    Private

    +
  • Defined in src/jobs/clean/firestore.ts:40

    • counter

    counter: number = 0
    @@ -112,7 +112,7 @@

    counter

    +
  • Defined in src/utils/template.ts:89

    • Private firestore

    firestore: Firestore
    @@ -120,7 +120,7 @@

    Private

    +
  • Defined in src/jobs/clean/firestore.ts:36

    • settings

    settings: Settings
    @@ -129,7 +129,7 @@

    settings

    +
  • Defined in src/utils/template.ts:27

    • startTimestamp

    startTimestamp: number
    @@ -138,7 +138,7 @@

    startTimestamp

    +
  • Defined in src/utils/template.ts:102

    • store

    store: Storage
    @@ -147,7 +147,7 @@

    store

    +
  • Defined in src/utils/template.ts:35

    • Static Private batchSize

    batchSize: number = 500
    @@ -155,7 +155,7 @@

    Static

    +
  • Defined in src/jobs/clean/firestore.ts:32

    • Methods

    @@ -173,7 +173,7 @@
    arr: Returns Promise<void>
    +
  • Defined in src/jobs/clean/firestore.ts:44

    • getWorkTime

    +
  • Defined in src/utils/template.ts:93

    • Private recursiveClean

    +
  • Defined in src/jobs/clean/firestore.ts:78

    • run

    +
  • Defined in src/jobs/clean/firestore.ts:112
    • @@ -247,7 +247,7 @@

    recursiveClean
  • run

    • -
    @@ -27,7 +27,7 @@

    Hierarchy

    +
  • Defined in src/jobs/clean/storage.ts:7
    • @@ -79,7 +79,7 @@

    Returns

    +
  • Defined in src/jobs/clean/storage.ts:13

    • Properties

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

    admin

    +
  • Defined in src/utils/template.ts:31

    • counter

    counter: number = 0
    @@ -99,7 +99,7 @@

    counter

    +
  • Defined in src/utils/template.ts:89

    • settings

    settings: Settings
    @@ -108,7 +108,7 @@

    settings

    +
  • Defined in src/utils/template.ts:27

    • startTimestamp

    startTimestamp: number
    @@ -117,7 +117,7 @@

    startTimestamp

    +
  • Defined in src/utils/template.ts:102

    • store

    store: Storage
    @@ -126,7 +126,7 @@

    store

    +
  • Defined in src/utils/template.ts:35

    • Methods

    @@ -140,7 +140,7 @@

    Returns string

    +
  • Defined in src/utils/template.ts:93

    • run

    +
  • Defined in src/jobs/clean/storage.ts:19
    • @@ -181,7 +181,7 @@

    getWorkTime
  • run

    • -
    @@ -27,7 +27,7 @@

    Hierarchy

    +
  • Defined in src/jobs/restore/auth.ts:13
    • @@ -85,7 +85,7 @@

    Returns

    +
  • Defined in src/jobs/restore/auth.ts:19

    • Properties

    @@ -96,7 +96,7 @@

    admin

    +
  • Defined in src/utils/template.ts:31

    • Private auth

    auth: Auth
    @@ -104,7 +104,7 @@

    Private

    +
  • Defined in src/jobs/restore/auth.ts:94

    • counter

    counter: number = 0
    @@ -113,7 +113,7 @@

    counter

    +
  • Defined in src/utils/template.ts:89

    • fileStream

    fileStream: ReadStream
    @@ -122,7 +122,7 @@

    fileStream

    +
  • Defined in src/utils/template.ts:174

    • Optional gunzipStream

    gunzipStream?: Gunzip
    @@ -131,7 +131,7 @@

    Optional

    +
  • Defined in src/utils/template.ts:178

    • parserStream

    parserStream: Transform
    @@ -140,7 +140,7 @@

    parserStream

    +
  • Defined in src/utils/template.ts:182

    • settings

    settings: Settings
    @@ -149,7 +149,7 @@

    settings

    +
  • Defined in src/utils/template.ts:27

    • startTimestamp

    startTimestamp: number
    @@ -158,7 +158,7 @@

    startTimestamp

    +
  • Defined in src/utils/template.ts:102

    • store

    store: Storage
    @@ -167,7 +167,7 @@

    store

    +
  • Defined in src/utils/template.ts:35

    • Private writeBuffer

    writeBuffer: {
        batch: {
            uid: string;
            [key: string]: any;
        }[];
        batchSize: number;
        clear: Function;
        commit: Function;
        iteration: number;
        set: Function;
    }
    @@ -208,7 +208,7 @@
    set
    +
  • Defined in src/jobs/restore/auth.ts:102

    • Private writeStream

    writeStream: Writable
    @@ -216,7 +216,7 @@

    Private

    +
  • Defined in src/jobs/restore/auth.ts:98

    • Methods

    @@ -230,7 +230,7 @@

    Returns string

    +
  • Defined in src/utils/template.ts:93

    • run

    +
  • Defined in src/jobs/restore/auth.ts:131
    • @@ -277,7 +277,7 @@

    getWorkTime
  • run

    • -
    @@ -27,7 +27,7 @@

    Hierarchy

    +
  • Defined in src/jobs/restore/firestore.ts:18
    • @@ -85,7 +85,7 @@

    Returns

    +
  • Defined in src/jobs/restore/firestore.ts:24

    • Properties

    @@ -96,7 +96,7 @@

    admin

    +
  • Defined in src/utils/template.ts:31

    • counter

    counter: number = 0
    @@ -105,7 +105,7 @@

    counter

    +
  • Defined in src/utils/template.ts:89

    • fileStream

    fileStream: ReadStream
    @@ -114,7 +114,7 @@

    fileStream

    +
  • Defined in src/utils/template.ts:174

    • Private firestore

    firestore: Firestore
    @@ -122,7 +122,7 @@

    Private

    +
  • Defined in src/jobs/restore/firestore.ts:110

    • Optional gunzipStream

    gunzipStream?: Gunzip
    @@ -131,7 +131,7 @@

    Optional

    +
  • Defined in src/utils/template.ts:178

    • parserStream

    parserStream: Transform
    @@ -140,7 +140,7 @@

    parserStream

    +
  • Defined in src/utils/template.ts:182

    • settings

    settings: Settings
    @@ -149,7 +149,7 @@

    settings

    +
  • Defined in src/utils/template.ts:27

    • startTimestamp

    startTimestamp: number
    @@ -158,7 +158,7 @@

    startTimestamp

    +
  • Defined in src/utils/template.ts:102

    • store

    store: Storage
    @@ -167,7 +167,7 @@

    store

    +
  • Defined in src/utils/template.ts:35

    • Private writeBuffer

    writeBuffer: {
        batch: WriteBatch;
        batchSize: number;
        clear: Function;
        commit: Function;
        iteration: number;
        set: Function;
    }
    @@ -208,7 +208,7 @@
    set
    +
  • Defined in src/jobs/restore/firestore.ts:118

    • Private writeStream

    writeStream: Writable
    @@ -216,7 +216,7 @@

    Private

    +
  • Defined in src/jobs/restore/firestore.ts:114

    • Methods

    @@ -230,7 +230,7 @@

    Returns string

    +
  • Defined in src/utils/template.ts:93

    • run

    +
  • Defined in src/jobs/restore/firestore.ts:147
    • @@ -277,7 +277,7 @@

    getWorkTime
  • run

    • -
    @@ -27,7 +27,7 @@

    Hierarchy

    +
  • Defined in src/jobs/restore/storage.ts:12
    • @@ -84,7 +84,7 @@

    Returns

    +
  • Defined in src/jobs/restore/storage.ts:18

    • Properties

    @@ -95,7 +95,7 @@

    admin

    +
  • Defined in src/utils/template.ts:31

    • Private buckets

    buckets: string[]
    @@ -103,7 +103,7 @@

    Private

    +
  • Defined in src/jobs/restore/storage.ts:80

    • counter

    counter: number = 0
    @@ -112,7 +112,7 @@

    counter

    +
  • Defined in src/utils/template.ts:89

    • fileStream

    fileStream: ReadStream
    @@ -121,7 +121,7 @@

    fileStream

    +
  • Defined in src/utils/template.ts:174

    • Optional gunzipStream

    gunzipStream?: Gunzip
    @@ -130,7 +130,7 @@

    Optional

    +
  • Defined in src/utils/template.ts:178

    • parserStream

    parserStream: Transform
    @@ -139,7 +139,7 @@

    parserStream

    +
  • Defined in src/utils/template.ts:182

    • settings

    settings: Settings
    @@ -148,7 +148,7 @@

    settings

    +
  • Defined in src/utils/template.ts:27

    • startTimestamp

    startTimestamp: number
    @@ -157,7 +157,7 @@

    startTimestamp

    +
  • Defined in src/utils/template.ts:102

    • store

    store: Storage
    @@ -166,7 +166,7 @@

    store

    +
  • Defined in src/utils/template.ts:35

    • Private writeStream

    writeStream: Writable
    @@ -174,7 +174,7 @@

    Private

    +
  • Defined in src/jobs/restore/storage.ts:84

    • Methods

    @@ -188,7 +188,7 @@

    Returns string

    +
  • Defined in src/utils/template.ts:93

    • run

    +
  • Defined in src/jobs/restore/storage.ts:88
    • @@ -234,7 +234,7 @@

    getWorkTime
  • run

    • -
    @@ -25,7 +25,7 @@

    Hierarchy

    +
  • Defined in src/utils/AuthConverter.ts:6
    • @@ -63,7 +63,7 @@

    Static

    +
  • Defined in src/utils/AuthConverter.ts:12

    • Methods

    @@ -91,7 +91,7 @@
    [
    uid: string
    +
  • Defined in src/utils/AuthConverter.ts:44

    • Static toString

    +
  • Defined in src/utils/AuthConverter.ts:32
    • @@ -135,7 +135,7 @@

    fromString
  • toString

    • -
    @@ -1067,7 +1067,7 @@

    verifyIdToken
  • verifySessionCookie

    • -
    @@ -259,7 +259,7 @@

    uid
  • toJSON

    • -
    @@ -467,7 +467,7 @@

    update
  • withConverter

    • -
    @@ -412,7 +412,7 @@

    settings
  • terminate

    • -
    @@ -132,7 +132,7 @@

    longitude
  • isEqual

    • -
    @@ -254,7 +254,7 @@

    fromMillis
  • now

    • -
    @@ -299,7 +299,7 @@

    set
  • update

    • -
    @@ -133,7 +133,7 @@

    app
  • bucket

    • -
    @@ -25,7 +25,7 @@

    Hierarchy

    +
  • Defined in src/utils/FirestoreConverter.ts:11
    • @@ -70,7 +70,7 @@
    d:

    Returns any

    +
  • Defined in src/utils/FirestoreConverter.ts:73

    • Static fromString

    +
  • Defined in src/utils/FirestoreConverter.ts:65

    • Static Private toObject

      @@ -113,7 +113,7 @@
      datatype: string
    +
  • Defined in src/utils/FirestoreConverter.ts:24

    • Static toString

    +
  • Defined in src/utils/FirestoreConverter.ts:16
    • @@ -161,7 +161,7 @@

    toObject
  • toString

    • -
    @@ -25,7 +25,7 @@

    Hierarchy

    +
  • Defined in src/utils/Logger.ts:4
    • @@ -67,7 +67,7 @@
    d:

    Returns void

    +
  • Defined in src/utils/Logger.ts:24

    • Static log

    +
  • Defined in src/utils/Logger.ts:8

    • Static table

    +
  • Defined in src/utils/Logger.ts:32

    • Static warn

    +
  • Defined in src/utils/Logger.ts:16
    • @@ -141,7 +141,7 @@

    table
  • warn

    • -
    @@ -25,7 +25,7 @@

    Hierarchy

    +
  • Defined in src/utils/StorageConverter.ts:4
    • @@ -68,7 +68,7 @@
    d:

    Returns Buffer

    +
  • Defined in src/utils/StorageConverter.ts:16

    • Static toString

    +
  • Defined in src/utils/StorageConverter.ts:9
    • @@ -111,7 +111,7 @@

    fromString
  • toString

    • -
    @@ -25,7 +25,7 @@

    Hierarchy

    +
  • Defined in src/utils/initialization.ts:30
    • @@ -61,7 +61,7 @@
    compress: Returns Writer
    +
  • Defined in src/utils/initialization.ts:35

    • Properties

    @@ -71,7 +71,7 @@

    compress

    +
  • Defined in src/utils/initialization.ts:55

    • fileStream

    fileStream: WriteStream
    @@ -79,7 +79,7 @@

    fileStream

    +
  • Defined in src/utils/initialization.ts:59

    • Optional gzipStream

    gzipStream?: Gzip
    @@ -87,7 +87,7 @@

    Optional

    +
  • Defined in src/utils/initialization.ts:63
    • @@ -112,7 +112,7 @@

    fileStream
  • gzipStream

    • -
    @@ -31,7 +31,7 @@

    Hierarchy

  • JobRestoreFirestore
  • JobRestoreStorage
    • +
  • Defined in src/utils/template.ts:145
    • @@ -86,7 +86,7 @@

    Returns

    +
  • Defined in src/utils/template.ts:151

    • Properties

    @@ -97,7 +97,7 @@

    admin

    +
  • Defined in src/utils/template.ts:31

    • counter

    counter: number = 0
    @@ -106,7 +106,7 @@

    counter

    +
  • Defined in src/utils/template.ts:89

    • fileStream

    fileStream: ReadStream
    @@ -114,7 +114,7 @@

    fileStream

    +
  • Defined in src/utils/template.ts:174

    • Optional gunzipStream

    gunzipStream?: Gunzip
    @@ -122,7 +122,7 @@

    Optional

    +
  • Defined in src/utils/template.ts:178

    • parserStream

    parserStream: Transform
    @@ -130,7 +130,7 @@

    parserStream

    +
  • Defined in src/utils/template.ts:182

    • settings

    settings: Settings
    @@ -139,7 +139,7 @@

    settings

    +
  • Defined in src/utils/template.ts:27

    • startTimestamp

    startTimestamp: number
    @@ -148,7 +148,7 @@

    startTimestamp

    +
  • Defined in src/utils/template.ts:102

    • store

    store: Storage
    @@ -157,7 +157,7 @@

    store

    +
  • Defined in src/utils/template.ts:35

    • Methods

    @@ -171,7 +171,7 @@

    Returns string

    +
  • Defined in src/utils/template.ts:93

    • run

    +
  • Defined in src/utils/template.ts:106
    • @@ -215,7 +215,7 @@

    getWorkTime
  • run

    • -
    @@ -31,7 +31,7 @@

    Hierarchy

  • JobBackupFirestore
  • JobBackupStorage
    • +
  • Defined in src/utils/template.ts:115
    • @@ -85,7 +85,7 @@

    Returns

    +
  • Defined in src/utils/template.ts:121

    • Properties

    @@ -96,7 +96,7 @@

    admin

    +
  • Defined in src/utils/template.ts:31

    • counter

    counter: number = 0
    @@ -105,7 +105,7 @@

    counter

    +
  • Defined in src/utils/template.ts:89

    • settings

    settings: Settings
    @@ -114,7 +114,7 @@

    settings

    +
  • Defined in src/utils/template.ts:27

    • startTimestamp

    startTimestamp: number
    @@ -123,7 +123,7 @@

    startTimestamp

    +
  • Defined in src/utils/template.ts:102

    • store

    store: Storage
    @@ -132,7 +132,7 @@

    store

    +
  • Defined in src/utils/template.ts:35

    • stringiferStream

    stringiferStream: Transform
    @@ -140,7 +140,7 @@

    stringiferStream

    +
  • Defined in src/utils/template.ts:139

    • writer

    writer: Writer
    @@ -148,7 +148,7 @@

    writer

    +
  • Defined in src/utils/template.ts:135

    • Methods

    @@ -162,7 +162,7 @@

    Returns string

    +
  • Defined in src/utils/template.ts:93

    • run

    +
  • Defined in src/utils/template.ts:106
    • @@ -205,7 +205,7 @@

    getWorkTime
  • run

    • -
    @@ -33,7 +33,7 @@

    Hierarchy

  • JobBackupServiceTemplate
  • JobBackupServiceRestoreTemplate
    • +
  • Defined in src/utils/template.ts:76
    • @@ -85,7 +85,7 @@

    Returns

    +
  • Defined in src/utils/template.ts:82

    • Properties

    @@ -96,7 +96,7 @@

    admin

    +
  • Defined in src/utils/template.ts:31

    • counter

    counter: number = 0
    @@ -104,7 +104,7 @@

    counter

    +
  • Defined in src/utils/template.ts:89

    • settings

    settings: Settings
    @@ -113,7 +113,7 @@

    settings

    +
  • Defined in src/utils/template.ts:27

    • startTimestamp

    startTimestamp: number
    @@ -121,7 +121,7 @@

    startTimestamp

    +
  • Defined in src/utils/template.ts:102

    • store

    store: Storage
    @@ -130,7 +130,7 @@

    store

    +
  • Defined in src/utils/template.ts:35

    • Methods

    @@ -143,7 +143,7 @@

    getWorkTimeReturns string

    +
  • Defined in src/utils/template.ts:93

    • run

    +
  • Defined in src/utils/template.ts:106
    • @@ -183,7 +183,7 @@

    getWorkTime
  • run

    • -
    @@ -27,7 +27,7 @@

    Hierarchy

    +
  • Defined in src/utils/template.ts:41
    • @@ -78,7 +78,7 @@

    Returns

    +
  • Defined in src/utils/template.ts:47

    • Properties

    @@ -89,7 +89,7 @@

    admin

    +
  • Defined in src/utils/template.ts:31

    • settings

    settings: Settings
    @@ -98,7 +98,7 @@

    settings

    +
  • Defined in src/utils/template.ts:27

    • store

    store: Storage
    @@ -107,7 +107,7 @@

    store

    +
  • Defined in src/utils/template.ts:35

    • Methods

    @@ -120,7 +120,7 @@

    authReturns Promise<void>

    +
  • Defined in src/utils/template.ts:60

    • firestore

    +
  • Defined in src/utils/template.ts:53

    • storage

    +
  • Defined in src/utils/template.ts:67
    • @@ -170,7 +170,7 @@

    firestore
  • storage

    • -
    @@ -29,7 +29,7 @@

    Hierarchy

  • JobOneTemplate
  • JobOneServiceTemplate
    • +
  • Defined in src/utils/template.ts:13
    • @@ -73,7 +73,7 @@
    store: Returns JobTemplate
    +
  • Defined in src/utils/template.ts:19

    • Properties

    @@ -83,7 +83,7 @@

    admin

    +
  • Defined in src/utils/template.ts:31

    • settings

    settings: Settings
    @@ -91,7 +91,7 @@

    settings

    +
  • Defined in src/utils/template.ts:27

    • store

    store: Storage
    @@ -99,7 +99,7 @@

    store

    +
  • Defined in src/utils/template.ts:35
    • @@ -124,7 +124,7 @@

    settings
  • store

    • -
    @@ -65,7 +65,7 @@

    Member Visibility

    Theme

    -
    @@ -71,7 +71,7 @@

    Member Visibility

    Theme

    -
    @@ -69,7 +69,7 @@

    Member Visibility

    Theme

    -
    @@ -46,7 +46,7 @@

    Member Visibility

    Theme

    -
    @@ -57,7 +57,7 @@

    Member Visibility

    Theme

    -
    @@ -119,7 +119,7 @@

    Member Visibility

    Theme

    -
    @@ -56,7 +56,7 @@

    Member Visibility

    Theme

    -
    @@ -30,7 +30,7 @@
    arg: Returns ParsedSettings
    +
  • Defined in src/utils/initialization.ts:199
    • @@ -47,7 +47,7 @@

    Member Visibility

    Theme

    -
    @@ -35,7 +35,7 @@
    compress: Returns Writer
    +
  • Defined in src/utils/initialization.ts:19
    • @@ -52,7 +52,7 @@

    Member Visibility

    Theme

    -
    @@ -40,7 +40,7 @@
    settingsstore: Storage
    +
  • Defined in src/utils/initialization.ts:350
    • @@ -57,7 +57,7 @@

    Member Visibility

    Theme

    -
    @@ -33,7 +33,7 @@
    length: Returns string
    +
  • Defined in src/utils/randomStr.ts:9
    • @@ -50,7 +50,7 @@

    Member Visibility

    Theme

    -
    -

    Firebase Engine - v1.5.97

    +

    Firebase Engine - v1.5.98

    firebase-engine

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

    npm npm @@ -202,7 +202,7 @@

    WARNING (restoration of subcollections)
  • LICENSE

    • -
    @@ -88,7 +88,7 @@

    name
  • options

    • -
    @@ -25,7 +25,7 @@

    Hierarchy

    +
  • Defined in src/utils/initialization.ts:69
    • @@ -52,7 +52,7 @@

    Optional

    +
  • Defined in src/utils/initialization.ts:81

    • buckets

    buckets: string[]
    @@ -60,7 +60,7 @@

    buckets

    +
  • Defined in src/utils/initialization.ts:107

    • collections

    collections: string[]
    @@ -68,7 +68,7 @@

    collections

    +
  • Defined in src/utils/initialization.ts:111

    • compress

    compress: boolean
    @@ -76,7 +76,7 @@

    compress

    +
  • Defined in src/utils/initialization.ts:89

    • emulators

    emulators: boolean
    @@ -84,7 +84,7 @@

    emulators

    +
  • Defined in src/utils/initialization.ts:93

    • hash_config

    hash_config: {
        algorithm?: HashAlgorithmType;
        base64_salt_separator?: Buffer;
        base64_signer_key?: Buffer;
        mem_cost?: number;
        rounds?: number;
    }
    @@ -105,7 +105,7 @@
    Optional Optional rounds?: number
    +
  • Defined in src/utils/initialization.ts:97

    • operations

    operations: ("backup" | "clean" | "restore")[]
    @@ -113,7 +113,7 @@

    operations

    +
  • Defined in src/utils/initialization.ts:73

    • Optional path

    path?: string
    @@ -121,7 +121,7 @@

    Optional

    +
  • Defined in src/utils/initialization.ts:77

    • services

    services: ("auth" | "firestore" | "storage")[]
    @@ -129,7 +129,7 @@

    services

    +
  • Defined in src/utils/initialization.ts:85
    • @@ -159,7 +159,7 @@

    path
  • services

    • -
    @@ -25,7 +25,7 @@

    Hierarchy

    +
  • Defined in src/utils/initialization.ts:155
    • @@ -51,7 +51,7 @@

    backup

    +
  • Defined in src/utils/initialization.ts:163

    • buckets

    buckets: string[]
    @@ -59,7 +59,7 @@

    buckets

    +
  • Defined in src/utils/initialization.ts:189

    • collections

    collections: string[]
    @@ -67,7 +67,7 @@

    collections

    +
  • Defined in src/utils/initialization.ts:193

    • compress

    compress: boolean
    @@ -75,7 +75,7 @@

    compress

    +
  • Defined in src/utils/initialization.ts:171

    • emulators

    emulators: boolean
    @@ -83,7 +83,7 @@

    emulators

    +
  • Defined in src/utils/initialization.ts:175

    • Optional hash_config

    hash_config?: {
        algorithm: HashAlgorithmType;
        key: Buffer;
        memoryCost: number;
        rounds: number;
        saltSeparator: Buffer;
    }
    @@ -104,7 +104,7 @@
    roundssaltSeparator: Buffer
    +
  • Defined in src/utils/initialization.ts:179

    • path

    path: string
    @@ -112,7 +112,7 @@

    path

    +
  • Defined in src/utils/initialization.ts:159

    • serviceAccount

    serviceAccount: {
        [key: string]: any;
    }
    @@ -125,7 +125,7 @@

    Type declaration

    [key: string]: any
    +
  • Defined in src/utils/initialization.ts:167
    • @@ -154,7 +154,7 @@

    path
  • serviceAccount

    • -
    @@ -25,7 +25,7 @@

    Hierarchy

    +
  • Defined in src/utils/initialization.ts:116
    • @@ -50,7 +50,7 @@

    Optional

    +
  • Defined in src/utils/initialization.ts:124

    • Optional buckets

    buckets?: string[]
    @@ -58,7 +58,7 @@

    Optional

    +
  • Defined in src/utils/initialization.ts:146

    • Optional collections

    collections?: string[]
    @@ -66,7 +66,7 @@

    Optional

    +
  • Defined in src/utils/initialization.ts:150

    • Optional compress

    compress?: boolean
    @@ -74,7 +74,7 @@

    Optional

    +
  • Defined in src/utils/initialization.ts:128

    • Optional emulators

    emulators?: boolean
    @@ -82,7 +82,7 @@

    Optional

    +
  • Defined in src/utils/initialization.ts:132

    • Optional hash_config

    hash_config?: {
        algorithm?: HashAlgorithmType;
        base64_salt_separator?: Buffer;
        base64_signer_key?: Buffer;
        mem_cost?: number;
        rounds?: number;
    }
    @@ -103,7 +103,7 @@
    Optional Optional rounds?: number
    +
  • Defined in src/utils/initialization.ts:136

    • Optional path

    path?: string
    @@ -111,7 +111,7 @@

    Optional

    +
  • Defined in src/utils/initialization.ts:120
    • @@ -139,7 +139,7 @@

    hash_config
  • path

    • -
    @@ -25,7 +25,7 @@

    Hierarchy

    +
  • Defined in src/utils/template.ts:188
    • @@ -46,7 +46,7 @@

    data

    +
  • Defined in src/utils/template.ts:200

    • path

    path: string
    @@ -54,7 +54,7 @@

    path

    +
  • Defined in src/utils/template.ts:196

    • service

    service: "auth" | "firestore" | "storage"
    @@ -62,7 +62,7 @@

    service

    +
  • Defined in src/utils/template.ts:192
    • @@ -86,7 +86,7 @@

    path
  • service

    • -
    @@ -16,7 +16,7 @@
  • FirebaseEngine

    • Module FirebaseEngine

    +
  • Defined in src/FirebaseEngine.ts:1

    • Index

    @@ -40,7 +40,7 @@

    Member Visibility

    Theme

    -
    @@ -16,7 +16,7 @@
  • bin/firebase-engine

    • Module bin/firebase-engine

    +
  • Defined in src/bin/firebase-engine.ts:1
    • @@ -33,7 +33,7 @@

    Member Visibility

    Theme

    -
    @@ -16,7 +16,7 @@
  • bin/firebase-engine-emulators

    • Module bin/firebase-engine-emulators

    +
  • Defined in src/bin/firebase-engine-emulators.ts:1
    • @@ -33,7 +33,7 @@

    Member Visibility

    Theme

    -
    @@ -16,7 +16,7 @@
  • index

    • Module index

    +
  • Defined in src/index.ts:1
    • @@ -33,7 +33,7 @@

    Member Visibility

    Theme

    -
    @@ -16,7 +16,7 @@
  • jobs/Jobs

    • Module jobs/Jobs

    +
  • Defined in src/jobs/Jobs.ts:1

    • Index

    @@ -40,7 +40,7 @@

    Member Visibility

    Theme

    -
    @@ -16,7 +16,7 @@
  • jobs/backup/auth

    • Module jobs/backup/auth

    +
  • Defined in src/jobs/backup/auth.ts:1

    • Index

    @@ -40,7 +40,7 @@

    Member Visibility

    Theme

    -
    @@ -16,7 +16,7 @@
  • jobs/backup/firestore

    • Module jobs/backup/firestore

    +
  • Defined in src/jobs/backup/firestore.ts:1

    • Index

    @@ -40,7 +40,7 @@

    Member Visibility

    Theme

    -
    @@ -16,7 +16,7 @@
  • jobs/backup/storage

    • Module jobs/backup/storage

    +
  • Defined in src/jobs/backup/storage.ts:1

    • Index

    @@ -40,7 +40,7 @@

    Member Visibility

    Theme

    -
    @@ -16,7 +16,7 @@
  • jobs/clean/auth

    • Module jobs/clean/auth

    +
  • Defined in src/jobs/clean/auth.ts:1

    • Index

    @@ -40,7 +40,7 @@

    Member Visibility

    Theme

    -
    @@ -16,7 +16,7 @@
  • jobs/clean/firestore

    • Module jobs/clean/firestore

    +
  • Defined in src/jobs/clean/firestore.ts:1

    • Index

    @@ -40,7 +40,7 @@

    Member Visibility

    Theme

    -
    @@ -16,7 +16,7 @@
  • jobs/clean/storage

    • Module jobs/clean/storage

    +
  • Defined in src/jobs/clean/storage.ts:1

    • Index

    @@ -40,7 +40,7 @@

    Member Visibility

    Theme

    -
    @@ -16,7 +16,7 @@
  • jobs/restore/auth

    • Module jobs/restore/auth

    +
  • Defined in src/jobs/restore/auth.ts:1

    • Index

    @@ -40,7 +40,7 @@

    Member Visibility

    Theme

    -
    @@ -16,7 +16,7 @@
  • jobs/restore/firestore

    • Module jobs/restore/firestore

    +
  • Defined in src/jobs/restore/firestore.ts:1

    • Index

    @@ -40,7 +40,7 @@

    Member Visibility

    Theme

    -
    @@ -16,7 +16,7 @@
  • jobs/restore/storage

    • Module jobs/restore/storage

    +
  • Defined in src/jobs/restore/storage.ts:1

    • Index

    @@ -40,7 +40,7 @@

    Member Visibility

    Theme

    -
    @@ -16,7 +16,7 @@
  • utils/AuthConverter

    • Module utils/AuthConverter

    +
  • Defined in src/utils/AuthConverter.ts:1

    • Index

    @@ -40,7 +40,7 @@

    Member Visibility

    Theme

    -
    @@ -47,7 +47,7 @@

    Member Visibility

    Theme

    -
    @@ -16,7 +16,7 @@
  • utils/FirebaseAdmin

    • Module utils/FirebaseAdmin

    +
  • Defined in src/utils/FirebaseAdmin.ts:1

    • Index

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

    Member Visibility

    Theme

    -
    @@ -16,7 +16,7 @@
  • utils/FirebaseAuth

    • Module utils/FirebaseAuth

    +
  • Defined in src/utils/FirebaseAuth.ts:1

    • Index

    @@ -49,7 +49,7 @@

    Member Visibility

    Theme

    -
    @@ -16,7 +16,7 @@
  • utils/FirebaseFirestore

    • Module utils/FirebaseFirestore

    +
  • Defined in src/utils/FirebaseFirestore.ts:1

    • Index

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

    Member Visibility

    Theme

    -
    @@ -16,7 +16,7 @@
  • utils/FirebaseStorage

    • Module utils/FirebaseStorage

    +
  • Defined in src/utils/FirebaseStorage.ts:1

    • Index

    @@ -44,7 +44,7 @@

    Member Visibility

    Theme

    -
    @@ -16,7 +16,7 @@
  • utils/FirestoreConverter

    • Module utils/FirestoreConverter

    +
  • Defined in src/utils/FirestoreConverter.ts:1

    • Index

    @@ -40,7 +40,7 @@

    Member Visibility

    Theme

    -
    @@ -16,7 +16,7 @@
  • utils/Logger

    • Module utils/Logger

    +
  • Defined in src/utils/Logger.ts:1

    • Index

    @@ -40,7 +40,7 @@

    Member Visibility

    Theme

    -
    @@ -16,7 +16,7 @@
  • utils/StorageConverter

    • Module utils/StorageConverter

    +
  • Defined in src/utils/StorageConverter.ts:1

    • Index

    @@ -40,7 +40,7 @@

    Member Visibility

    Theme

    -
    @@ -16,7 +16,7 @@
  • utils/initialization

    • Module utils/initialization

    +
  • Defined in src/utils/initialization.ts:1

    • Index

    @@ -56,7 +56,7 @@

    Member Visibility

    Theme

    -
    @@ -16,7 +16,7 @@
  • utils/randomStr

    • Module utils/randomStr

    +
  • Defined in src/utils/randomStr.ts:1

    • Index

    @@ -40,7 +40,7 @@

    Member Visibility

    Theme

    -
    @@ -16,7 +16,7 @@
  • utils/template

    • Module utils/template

    +
  • Defined in src/utils/template.ts:1

    • Index

    @@ -48,7 +48,7 @@

    Member Visibility

    Theme

    -
    @@ -42,7 +42,7 @@

    Member Visibility

    Theme

    -
    @@ -35,7 +35,7 @@

    Member Visibility

    Theme

    -
    @@ -44,7 +44,7 @@

    Member Visibility

    Theme

    -
    @@ -35,7 +35,7 @@

    Member Visibility

    Theme

    -
    @@ -26,7 +26,7 @@

    Type declaration

    [key: string]: Writer
    +
  • Defined in src/utils/initialization.ts:13
    • @@ -43,7 +43,7 @@

    Member Visibility

    Theme

    -