@firebase/database 1.0.9 → 1.0.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs.js +13834 -13834
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm2017.js +13834 -13834
- package/dist/index.esm2017.js.map +1 -1
- package/dist/index.node.cjs.js +13849 -13849
- package/dist/index.node.cjs.js.map +1 -1
- package/dist/index.standalone.js +13797 -13797
- package/dist/index.standalone.js.map +1 -1
- package/dist/node-esm/index.node.esm.js +13849 -13849
- package/dist/node-esm/index.node.esm.js.map +1 -1
- package/dist/node-esm/src/api/Database.d.ts +137 -137
- package/dist/node-esm/src/api/OnDisconnect.d.ts +110 -110
- package/dist/node-esm/src/api/Reference.d.ts +122 -122
- package/dist/node-esm/src/api/Reference_impl.d.ts +1098 -1098
- package/dist/node-esm/src/api/ServerValue.d.ts +30 -30
- package/dist/node-esm/src/api/Transaction.d.ts +83 -83
- package/dist/node-esm/src/api/test_access.d.ts +31 -31
- package/dist/node-esm/src/api.d.ts +18 -18
- package/dist/node-esm/src/api.standalone.d.ts +30 -30
- package/dist/node-esm/src/core/AppCheckTokenProvider.d.ts +30 -30
- package/dist/node-esm/src/core/AuthTokenProvider.d.ts +49 -49
- package/dist/node-esm/src/core/CompoundWrite.d.ts +81 -81
- package/dist/node-esm/src/core/PersistentConnection.d.ts +135 -135
- package/dist/node-esm/src/core/ReadonlyRestClient.d.ts +60 -60
- package/dist/node-esm/src/core/Repo.d.ts +144 -144
- package/dist/node-esm/src/core/RepoInfo.d.ts +56 -56
- package/dist/node-esm/src/core/ServerActions.d.ts +52 -52
- package/dist/node-esm/src/core/SnapshotHolder.d.ts +26 -26
- package/dist/node-esm/src/core/SparseSnapshotTree.d.ts +64 -64
- package/dist/node-esm/src/core/SyncPoint.d.ts +91 -91
- package/dist/node-esm/src/core/SyncTree.d.ts +166 -166
- package/dist/node-esm/src/core/WriteTree.d.ts +205 -205
- package/dist/node-esm/src/core/operation/AckUserWrite.d.ts +36 -36
- package/dist/node-esm/src/core/operation/ListenComplete.d.ts +26 -26
- package/dist/node-esm/src/core/operation/Merge.d.ts +33 -33
- package/dist/node-esm/src/core/operation/Operation.d.ts +45 -45
- package/dist/node-esm/src/core/operation/Overwrite.d.ts +28 -28
- package/dist/node-esm/src/core/snap/ChildrenNode.d.ts +112 -112
- package/dist/node-esm/src/core/snap/IndexMap.d.ts +43 -43
- package/dist/node-esm/src/core/snap/LeafNode.d.ts +83 -83
- package/dist/node-esm/src/core/snap/Node.d.ts +126 -126
- package/dist/node-esm/src/core/snap/childSet.d.ts +32 -32
- package/dist/node-esm/src/core/snap/comparators.d.ts +19 -19
- package/dist/node-esm/src/core/snap/indexes/Index.d.ts +50 -50
- package/dist/node-esm/src/core/snap/indexes/KeyIndex.d.ts +34 -34
- package/dist/node-esm/src/core/snap/indexes/PathIndex.d.ts +29 -29
- package/dist/node-esm/src/core/snap/indexes/PriorityIndex.d.ts +33 -33
- package/dist/node-esm/src/core/snap/indexes/ValueIndex.d.ts +31 -31
- package/dist/node-esm/src/core/snap/nodeFromJSON.d.ts +24 -24
- package/dist/node-esm/src/core/snap/snap.d.ts +23 -23
- package/dist/node-esm/src/core/stats/StatsCollection.d.ts +26 -26
- package/dist/node-esm/src/core/stats/StatsListener.d.ts +30 -30
- package/dist/node-esm/src/core/stats/StatsManager.d.ts +20 -20
- package/dist/node-esm/src/core/stats/StatsReporter.d.ts +28 -28
- package/dist/node-esm/src/core/storage/DOMStorageWrapper.d.ts +46 -46
- package/dist/node-esm/src/core/storage/MemoryStorage.d.ts +27 -27
- package/dist/node-esm/src/core/storage/storage.d.ts +22 -22
- package/dist/node-esm/src/core/util/EventEmitter.d.ts +39 -39
- package/dist/node-esm/src/core/util/ImmutableTree.d.ts +117 -117
- package/dist/node-esm/src/core/util/NextPushId.d.ts +33 -33
- package/dist/node-esm/src/core/util/OnlineMonitor.d.ts +31 -31
- package/dist/node-esm/src/core/util/Path.d.ts +94 -94
- package/dist/node-esm/src/core/util/ServerValues.d.ts +56 -56
- package/dist/node-esm/src/core/util/SortedMap.d.ts +324 -324
- package/dist/node-esm/src/core/util/Tree.d.ts +105 -105
- package/dist/node-esm/src/core/util/VisibilityMonitor.d.ts +23 -23
- package/dist/node-esm/src/core/util/libs/parser.d.ts +32 -32
- package/dist/node-esm/src/core/util/misc.d.ts +19 -19
- package/dist/node-esm/src/core/util/util.d.ts +176 -176
- package/dist/node-esm/src/core/util/validation.d.ts +70 -70
- package/dist/node-esm/src/core/version.d.ts +23 -23
- package/dist/node-esm/src/core/view/CacheNode.d.ts +41 -41
- package/dist/node-esm/src/core/view/Change.d.ts +46 -46
- package/dist/node-esm/src/core/view/ChildChangeAccumulator.d.ts +22 -22
- package/dist/node-esm/src/core/view/CompleteChildSource.d.ts +55 -55
- package/dist/node-esm/src/core/view/Event.d.ts +64 -64
- package/dist/node-esm/src/core/view/EventGenerator.d.ts +42 -42
- package/dist/node-esm/src/core/view/EventQueue.d.ts +67 -67
- package/dist/node-esm/src/core/view/EventRegistration.d.ts +87 -87
- package/dist/node-esm/src/core/view/QueryParams.d.ts +95 -95
- package/dist/node-esm/src/core/view/View.d.ts +59 -59
- package/dist/node-esm/src/core/view/ViewCache.d.ts +32 -32
- package/dist/node-esm/src/core/view/ViewProcessor.d.ts +32 -32
- package/dist/node-esm/src/core/view/filter/IndexedFilter.d.ts +35 -35
- package/dist/node-esm/src/core/view/filter/LimitedFilter.d.ts +47 -47
- package/dist/node-esm/src/core/view/filter/NodeFilter.d.ts +54 -54
- package/dist/node-esm/src/core/view/filter/RangedFilter.d.ts +47 -47
- package/dist/node-esm/src/index.d.ts +28 -28
- package/dist/node-esm/src/index.node.d.ts +17 -17
- package/dist/node-esm/src/index.standalone.d.ts +17 -17
- package/dist/node-esm/src/internal/index.d.ts +38 -38
- package/dist/node-esm/src/realtime/BrowserPollConnection.d.ts +198 -198
- package/dist/node-esm/src/realtime/Connection.d.ts +102 -102
- package/dist/node-esm/src/realtime/Constants.d.ts +27 -27
- package/dist/node-esm/src/realtime/Transport.d.ts +58 -58
- package/dist/node-esm/src/realtime/TransportManager.d.ts +50 -50
- package/dist/node-esm/src/realtime/WebSocketConnection.d.ts +127 -127
- package/dist/node-esm/src/realtime/polling/PacketReceiver.d.ts +38 -38
- package/dist/node-esm/src/register.d.ts +1 -1
- package/dist/node-esm/test/compound_write.test.d.ts +17 -17
- package/dist/node-esm/test/connection.test.d.ts +17 -17
- package/dist/node-esm/test/deno.test.d.ts +17 -17
- package/dist/node-esm/test/exp/integration.test.d.ts +17 -17
- package/dist/node-esm/test/helpers/EventAccumulator.d.ts +35 -35
- package/dist/node-esm/test/helpers/syncpoint-util.d.ts +29 -29
- package/dist/node-esm/test/helpers/util.d.ts +34 -34
- package/dist/node-esm/test/node.test.d.ts +17 -17
- package/dist/node-esm/test/parser.test.d.ts +17 -17
- package/dist/node-esm/test/path.test.d.ts +17 -17
- package/dist/node-esm/test/pushid.test.d.ts +17 -17
- package/dist/node-esm/test/queryconstraint.test.d.ts +17 -17
- package/dist/node-esm/test/repoinfo.test.d.ts +17 -17
- package/dist/node-esm/test/sortedmap.test.d.ts +17 -17
- package/dist/node-esm/test/sparsesnapshottree.test.d.ts +17 -17
- package/dist/node-esm/test/syncpoint.test.d.ts +17 -17
- package/dist/node-esm/test/transport.test.d.ts +17 -17
- package/dist/node-esm/test/websocketconnection.test.d.ts +17 -17
- package/dist/src/api/Database.d.ts +137 -137
- package/dist/src/api/OnDisconnect.d.ts +110 -110
- package/dist/src/api/Reference.d.ts +122 -122
- package/dist/src/api/Reference_impl.d.ts +1098 -1098
- package/dist/src/api/ServerValue.d.ts +30 -30
- package/dist/src/api/Transaction.d.ts +83 -83
- package/dist/src/api/test_access.d.ts +31 -31
- package/dist/src/api.d.ts +18 -18
- package/dist/src/api.standalone.d.ts +30 -30
- package/dist/src/core/AppCheckTokenProvider.d.ts +30 -30
- package/dist/src/core/AuthTokenProvider.d.ts +49 -49
- package/dist/src/core/CompoundWrite.d.ts +81 -81
- package/dist/src/core/PersistentConnection.d.ts +135 -135
- package/dist/src/core/ReadonlyRestClient.d.ts +60 -60
- package/dist/src/core/Repo.d.ts +144 -144
- package/dist/src/core/RepoInfo.d.ts +56 -56
- package/dist/src/core/ServerActions.d.ts +52 -52
- package/dist/src/core/SnapshotHolder.d.ts +26 -26
- package/dist/src/core/SparseSnapshotTree.d.ts +64 -64
- package/dist/src/core/SyncPoint.d.ts +91 -91
- package/dist/src/core/SyncTree.d.ts +166 -166
- package/dist/src/core/WriteTree.d.ts +205 -205
- package/dist/src/core/operation/AckUserWrite.d.ts +36 -36
- package/dist/src/core/operation/ListenComplete.d.ts +26 -26
- package/dist/src/core/operation/Merge.d.ts +33 -33
- package/dist/src/core/operation/Operation.d.ts +45 -45
- package/dist/src/core/operation/Overwrite.d.ts +28 -28
- package/dist/src/core/snap/ChildrenNode.d.ts +112 -112
- package/dist/src/core/snap/IndexMap.d.ts +43 -43
- package/dist/src/core/snap/LeafNode.d.ts +83 -83
- package/dist/src/core/snap/Node.d.ts +126 -126
- package/dist/src/core/snap/childSet.d.ts +32 -32
- package/dist/src/core/snap/comparators.d.ts +19 -19
- package/dist/src/core/snap/indexes/Index.d.ts +50 -50
- package/dist/src/core/snap/indexes/KeyIndex.d.ts +34 -34
- package/dist/src/core/snap/indexes/PathIndex.d.ts +29 -29
- package/dist/src/core/snap/indexes/PriorityIndex.d.ts +33 -33
- package/dist/src/core/snap/indexes/ValueIndex.d.ts +31 -31
- package/dist/src/core/snap/nodeFromJSON.d.ts +24 -24
- package/dist/src/core/snap/snap.d.ts +23 -23
- package/dist/src/core/stats/StatsCollection.d.ts +26 -26
- package/dist/src/core/stats/StatsListener.d.ts +30 -30
- package/dist/src/core/stats/StatsManager.d.ts +20 -20
- package/dist/src/core/stats/StatsReporter.d.ts +28 -28
- package/dist/src/core/storage/DOMStorageWrapper.d.ts +46 -46
- package/dist/src/core/storage/MemoryStorage.d.ts +27 -27
- package/dist/src/core/storage/storage.d.ts +22 -22
- package/dist/src/core/util/EventEmitter.d.ts +39 -39
- package/dist/src/core/util/ImmutableTree.d.ts +117 -117
- package/dist/src/core/util/NextPushId.d.ts +33 -33
- package/dist/src/core/util/OnlineMonitor.d.ts +31 -31
- package/dist/src/core/util/Path.d.ts +94 -94
- package/dist/src/core/util/ServerValues.d.ts +56 -56
- package/dist/src/core/util/SortedMap.d.ts +324 -324
- package/dist/src/core/util/Tree.d.ts +105 -105
- package/dist/src/core/util/VisibilityMonitor.d.ts +23 -23
- package/dist/src/core/util/libs/parser.d.ts +32 -32
- package/dist/src/core/util/misc.d.ts +19 -19
- package/dist/src/core/util/util.d.ts +176 -176
- package/dist/src/core/util/validation.d.ts +70 -70
- package/dist/src/core/version.d.ts +23 -23
- package/dist/src/core/view/CacheNode.d.ts +41 -41
- package/dist/src/core/view/Change.d.ts +46 -46
- package/dist/src/core/view/ChildChangeAccumulator.d.ts +22 -22
- package/dist/src/core/view/CompleteChildSource.d.ts +55 -55
- package/dist/src/core/view/Event.d.ts +64 -64
- package/dist/src/core/view/EventGenerator.d.ts +42 -42
- package/dist/src/core/view/EventQueue.d.ts +67 -67
- package/dist/src/core/view/EventRegistration.d.ts +87 -87
- package/dist/src/core/view/QueryParams.d.ts +95 -95
- package/dist/src/core/view/View.d.ts +59 -59
- package/dist/src/core/view/ViewCache.d.ts +32 -32
- package/dist/src/core/view/ViewProcessor.d.ts +32 -32
- package/dist/src/core/view/filter/IndexedFilter.d.ts +35 -35
- package/dist/src/core/view/filter/LimitedFilter.d.ts +47 -47
- package/dist/src/core/view/filter/NodeFilter.d.ts +54 -54
- package/dist/src/core/view/filter/RangedFilter.d.ts +47 -47
- package/dist/src/index.d.ts +28 -28
- package/dist/src/index.node.d.ts +17 -17
- package/dist/src/index.standalone.d.ts +17 -17
- package/dist/src/internal/index.d.ts +38 -38
- package/dist/src/realtime/BrowserPollConnection.d.ts +198 -198
- package/dist/src/realtime/Connection.d.ts +102 -102
- package/dist/src/realtime/Constants.d.ts +27 -27
- package/dist/src/realtime/Transport.d.ts +58 -58
- package/dist/src/realtime/TransportManager.d.ts +50 -50
- package/dist/src/realtime/WebSocketConnection.d.ts +127 -127
- package/dist/src/realtime/polling/PacketReceiver.d.ts +38 -38
- package/dist/src/register.d.ts +1 -1
- package/dist/test/compound_write.test.d.ts +17 -17
- package/dist/test/connection.test.d.ts +17 -17
- package/dist/test/deno.test.d.ts +17 -17
- package/dist/test/exp/integration.test.d.ts +17 -17
- package/dist/test/helpers/EventAccumulator.d.ts +35 -35
- package/dist/test/helpers/syncpoint-util.d.ts +29 -29
- package/dist/test/helpers/util.d.ts +34 -34
- package/dist/test/node.test.d.ts +17 -17
- package/dist/test/parser.test.d.ts +17 -17
- package/dist/test/path.test.d.ts +17 -17
- package/dist/test/pushid.test.d.ts +17 -17
- package/dist/test/queryconstraint.test.d.ts +17 -17
- package/dist/test/repoinfo.test.d.ts +17 -17
- package/dist/test/sortedmap.test.d.ts +17 -17
- package/dist/test/sparsesnapshottree.test.d.ts +17 -17
- package/dist/test/syncpoint.test.d.ts +17 -17
- package/dist/test/transport.test.d.ts +17 -17
- package/dist/test/websocketconnection.test.d.ts +17 -17
- package/package.json +8 -8
|
@@ -1,30 +1,30 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @license
|
|
3
|
-
* Copyright 2020 Google LLC
|
|
4
|
-
*
|
|
5
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
-
* you may not use this file except in compliance with the License.
|
|
7
|
-
* You may obtain a copy of the License at
|
|
8
|
-
*
|
|
9
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
-
*
|
|
11
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
-
* See the License for the specific language governing permissions and
|
|
15
|
-
* limitations under the License.
|
|
16
|
-
*/
|
|
17
|
-
/**
|
|
18
|
-
* Returns a placeholder value for auto-populating the current timestamp (time
|
|
19
|
-
* since the Unix epoch, in milliseconds) as determined by the Firebase
|
|
20
|
-
* servers.
|
|
21
|
-
*/
|
|
22
|
-
export declare function serverTimestamp(): object;
|
|
23
|
-
/**
|
|
24
|
-
* Returns a placeholder value that can be used to atomically increment the
|
|
25
|
-
* current database value by the provided delta.
|
|
26
|
-
*
|
|
27
|
-
* @param delta - the amount to modify the current value atomically.
|
|
28
|
-
* @returns A placeholder value for modifying data atomically server-side.
|
|
29
|
-
*/
|
|
30
|
-
export declare function increment(delta: number): object;
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
* Copyright 2020 Google LLC
|
|
4
|
+
*
|
|
5
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
* you may not use this file except in compliance with the License.
|
|
7
|
+
* You may obtain a copy of the License at
|
|
8
|
+
*
|
|
9
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
*
|
|
11
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
* See the License for the specific language governing permissions and
|
|
15
|
+
* limitations under the License.
|
|
16
|
+
*/
|
|
17
|
+
/**
|
|
18
|
+
* Returns a placeholder value for auto-populating the current timestamp (time
|
|
19
|
+
* since the Unix epoch, in milliseconds) as determined by the Firebase
|
|
20
|
+
* servers.
|
|
21
|
+
*/
|
|
22
|
+
export declare function serverTimestamp(): object;
|
|
23
|
+
/**
|
|
24
|
+
* Returns a placeholder value that can be used to atomically increment the
|
|
25
|
+
* current database value by the provided delta.
|
|
26
|
+
*
|
|
27
|
+
* @param delta - the amount to modify the current value atomically.
|
|
28
|
+
* @returns A placeholder value for modifying data atomically server-side.
|
|
29
|
+
*/
|
|
30
|
+
export declare function increment(delta: number): object;
|
|
@@ -1,83 +1,83 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @license
|
|
3
|
-
* Copyright 2020 Google LLC
|
|
4
|
-
*
|
|
5
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
-
* you may not use this file except in compliance with the License.
|
|
7
|
-
* You may obtain a copy of the License at
|
|
8
|
-
*
|
|
9
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
-
*
|
|
11
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
-
* See the License for the specific language governing permissions and
|
|
15
|
-
* limitations under the License.
|
|
16
|
-
*/
|
|
17
|
-
import { DatabaseReference } from './Reference';
|
|
18
|
-
import { DataSnapshot } from './Reference_impl';
|
|
19
|
-
/** An options object to configure transactions. */
|
|
20
|
-
export interface TransactionOptions {
|
|
21
|
-
/**
|
|
22
|
-
* By default, events are raised each time the transaction update function
|
|
23
|
-
* runs. So if it is run multiple times, you may see intermediate states. You
|
|
24
|
-
* can set this to false to suppress these intermediate states and instead
|
|
25
|
-
* wait until the transaction has completed before events are raised.
|
|
26
|
-
*/
|
|
27
|
-
readonly applyLocally?: boolean;
|
|
28
|
-
}
|
|
29
|
-
/**
|
|
30
|
-
* A type for the resolve value of {@link runTransaction}.
|
|
31
|
-
*/
|
|
32
|
-
export declare class TransactionResult {
|
|
33
|
-
/** Whether the transaction was successfully committed. */
|
|
34
|
-
readonly committed: boolean;
|
|
35
|
-
/** The resulting data snapshot. */
|
|
36
|
-
readonly snapshot: DataSnapshot;
|
|
37
|
-
/** @hideconstructor */
|
|
38
|
-
constructor(
|
|
39
|
-
/** Whether the transaction was successfully committed. */
|
|
40
|
-
committed: boolean,
|
|
41
|
-
/** The resulting data snapshot. */
|
|
42
|
-
snapshot: DataSnapshot);
|
|
43
|
-
/** Returns a JSON-serializable representation of this object. */
|
|
44
|
-
toJSON(): object;
|
|
45
|
-
}
|
|
46
|
-
/**
|
|
47
|
-
* Atomically modifies the data at this location.
|
|
48
|
-
*
|
|
49
|
-
* Atomically modify the data at this location. Unlike a normal `set()`, which
|
|
50
|
-
* just overwrites the data regardless of its previous value, `runTransaction()` is
|
|
51
|
-
* used to modify the existing value to a new value, ensuring there are no
|
|
52
|
-
* conflicts with other clients writing to the same location at the same time.
|
|
53
|
-
*
|
|
54
|
-
* To accomplish this, you pass `runTransaction()` an update function which is
|
|
55
|
-
* used to transform the current value into a new value. If another client
|
|
56
|
-
* writes to the location before your new value is successfully written, your
|
|
57
|
-
* update function will be called again with the new current value, and the
|
|
58
|
-
* write will be retried. This will happen repeatedly until your write succeeds
|
|
59
|
-
* without conflict or you abort the transaction by not returning a value from
|
|
60
|
-
* your update function.
|
|
61
|
-
*
|
|
62
|
-
* Note: Modifying data with `set()` will cancel any pending transactions at
|
|
63
|
-
* that location, so extreme care should be taken if mixing `set()` and
|
|
64
|
-
* `runTransaction()` to update the same data.
|
|
65
|
-
*
|
|
66
|
-
* Note: When using transactions with Security and Firebase Rules in place, be
|
|
67
|
-
* aware that a client needs `.read` access in addition to `.write` access in
|
|
68
|
-
* order to perform a transaction. This is because the client-side nature of
|
|
69
|
-
* transactions requires the client to read the data in order to transactionally
|
|
70
|
-
* update it.
|
|
71
|
-
*
|
|
72
|
-
* @param ref - The location to atomically modify.
|
|
73
|
-
* @param transactionUpdate - A developer-supplied function which will be passed
|
|
74
|
-
* the current data stored at this location (as a JavaScript object). The
|
|
75
|
-
* function should return the new value it would like written (as a JavaScript
|
|
76
|
-
* object). If `undefined` is returned (i.e. you return with no arguments) the
|
|
77
|
-
* transaction will be aborted and the data at this location will not be
|
|
78
|
-
* modified.
|
|
79
|
-
* @param options - An options object to configure transactions.
|
|
80
|
-
* @returns A `Promise` that can optionally be used instead of the `onComplete`
|
|
81
|
-
* callback to handle success and failure.
|
|
82
|
-
*/
|
|
83
|
-
export declare function runTransaction(ref: DatabaseReference, transactionUpdate: (currentData: any) => unknown, options?: TransactionOptions): Promise<TransactionResult>;
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
* Copyright 2020 Google LLC
|
|
4
|
+
*
|
|
5
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
* you may not use this file except in compliance with the License.
|
|
7
|
+
* You may obtain a copy of the License at
|
|
8
|
+
*
|
|
9
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
*
|
|
11
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
* See the License for the specific language governing permissions and
|
|
15
|
+
* limitations under the License.
|
|
16
|
+
*/
|
|
17
|
+
import { DatabaseReference } from './Reference';
|
|
18
|
+
import { DataSnapshot } from './Reference_impl';
|
|
19
|
+
/** An options object to configure transactions. */
|
|
20
|
+
export interface TransactionOptions {
|
|
21
|
+
/**
|
|
22
|
+
* By default, events are raised each time the transaction update function
|
|
23
|
+
* runs. So if it is run multiple times, you may see intermediate states. You
|
|
24
|
+
* can set this to false to suppress these intermediate states and instead
|
|
25
|
+
* wait until the transaction has completed before events are raised.
|
|
26
|
+
*/
|
|
27
|
+
readonly applyLocally?: boolean;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* A type for the resolve value of {@link runTransaction}.
|
|
31
|
+
*/
|
|
32
|
+
export declare class TransactionResult {
|
|
33
|
+
/** Whether the transaction was successfully committed. */
|
|
34
|
+
readonly committed: boolean;
|
|
35
|
+
/** The resulting data snapshot. */
|
|
36
|
+
readonly snapshot: DataSnapshot;
|
|
37
|
+
/** @hideconstructor */
|
|
38
|
+
constructor(
|
|
39
|
+
/** Whether the transaction was successfully committed. */
|
|
40
|
+
committed: boolean,
|
|
41
|
+
/** The resulting data snapshot. */
|
|
42
|
+
snapshot: DataSnapshot);
|
|
43
|
+
/** Returns a JSON-serializable representation of this object. */
|
|
44
|
+
toJSON(): object;
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* Atomically modifies the data at this location.
|
|
48
|
+
*
|
|
49
|
+
* Atomically modify the data at this location. Unlike a normal `set()`, which
|
|
50
|
+
* just overwrites the data regardless of its previous value, `runTransaction()` is
|
|
51
|
+
* used to modify the existing value to a new value, ensuring there are no
|
|
52
|
+
* conflicts with other clients writing to the same location at the same time.
|
|
53
|
+
*
|
|
54
|
+
* To accomplish this, you pass `runTransaction()` an update function which is
|
|
55
|
+
* used to transform the current value into a new value. If another client
|
|
56
|
+
* writes to the location before your new value is successfully written, your
|
|
57
|
+
* update function will be called again with the new current value, and the
|
|
58
|
+
* write will be retried. This will happen repeatedly until your write succeeds
|
|
59
|
+
* without conflict or you abort the transaction by not returning a value from
|
|
60
|
+
* your update function.
|
|
61
|
+
*
|
|
62
|
+
* Note: Modifying data with `set()` will cancel any pending transactions at
|
|
63
|
+
* that location, so extreme care should be taken if mixing `set()` and
|
|
64
|
+
* `runTransaction()` to update the same data.
|
|
65
|
+
*
|
|
66
|
+
* Note: When using transactions with Security and Firebase Rules in place, be
|
|
67
|
+
* aware that a client needs `.read` access in addition to `.write` access in
|
|
68
|
+
* order to perform a transaction. This is because the client-side nature of
|
|
69
|
+
* transactions requires the client to read the data in order to transactionally
|
|
70
|
+
* update it.
|
|
71
|
+
*
|
|
72
|
+
* @param ref - The location to atomically modify.
|
|
73
|
+
* @param transactionUpdate - A developer-supplied function which will be passed
|
|
74
|
+
* the current data stored at this location (as a JavaScript object). The
|
|
75
|
+
* function should return the new value it would like written (as a JavaScript
|
|
76
|
+
* object). If `undefined` is returned (i.e. you return with no arguments) the
|
|
77
|
+
* transaction will be aborted and the data at this location will not be
|
|
78
|
+
* modified.
|
|
79
|
+
* @param options - An options object to configure transactions.
|
|
80
|
+
* @returns A `Promise` that can optionally be used instead of the `onComplete`
|
|
81
|
+
* callback to handle success and failure.
|
|
82
|
+
*/
|
|
83
|
+
export declare function runTransaction(ref: DatabaseReference, transactionUpdate: (currentData: any) => unknown, options?: TransactionOptions): Promise<TransactionResult>;
|
|
@@ -1,31 +1,31 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @license
|
|
3
|
-
* Copyright 2017 Google LLC
|
|
4
|
-
*
|
|
5
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
-
* you may not use this file except in compliance with the License.
|
|
7
|
-
* You may obtain a copy of the License at
|
|
8
|
-
*
|
|
9
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
-
*
|
|
11
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
-
* See the License for the specific language governing permissions and
|
|
15
|
-
* limitations under the License.
|
|
16
|
-
*/
|
|
17
|
-
import { PersistentConnection } from '../core/PersistentConnection';
|
|
18
|
-
import { RepoInfo } from '../core/RepoInfo';
|
|
19
|
-
import { Connection } from '../realtime/Connection';
|
|
20
|
-
export declare const DataConnection: typeof PersistentConnection;
|
|
21
|
-
export declare const RealTimeConnection: typeof Connection;
|
|
22
|
-
/**
|
|
23
|
-
* @internal
|
|
24
|
-
*/
|
|
25
|
-
export declare const hijackHash: (newHash: () => string) => () => void;
|
|
26
|
-
export declare const ConnectionTarget: typeof RepoInfo;
|
|
27
|
-
/**
|
|
28
|
-
* Forces the RepoManager to create Repos that use ReadonlyRestClient instead of PersistentConnection.
|
|
29
|
-
* @internal
|
|
30
|
-
*/
|
|
31
|
-
export declare const forceRestClient: (forceRestClient: boolean) => void;
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
* Copyright 2017 Google LLC
|
|
4
|
+
*
|
|
5
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
* you may not use this file except in compliance with the License.
|
|
7
|
+
* You may obtain a copy of the License at
|
|
8
|
+
*
|
|
9
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
*
|
|
11
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
* See the License for the specific language governing permissions and
|
|
15
|
+
* limitations under the License.
|
|
16
|
+
*/
|
|
17
|
+
import { PersistentConnection } from '../core/PersistentConnection';
|
|
18
|
+
import { RepoInfo } from '../core/RepoInfo';
|
|
19
|
+
import { Connection } from '../realtime/Connection';
|
|
20
|
+
export declare const DataConnection: typeof PersistentConnection;
|
|
21
|
+
export declare const RealTimeConnection: typeof Connection;
|
|
22
|
+
/**
|
|
23
|
+
* @internal
|
|
24
|
+
*/
|
|
25
|
+
export declare const hijackHash: (newHash: () => string) => () => void;
|
|
26
|
+
export declare const ConnectionTarget: typeof RepoInfo;
|
|
27
|
+
/**
|
|
28
|
+
* Forces the RepoManager to create Repos that use ReadonlyRestClient instead of PersistentConnection.
|
|
29
|
+
* @internal
|
|
30
|
+
*/
|
|
31
|
+
export declare const forceRestClient: (forceRestClient: boolean) => void;
|
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @license
|
|
3
|
-
* Copyright 2021 Google LLC
|
|
4
|
-
*
|
|
5
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
-
* you may not use this file except in compliance with the License.
|
|
7
|
-
* You may obtain a copy of the License at
|
|
8
|
-
*
|
|
9
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
-
*
|
|
11
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
-
* See the License for the specific language governing permissions and
|
|
15
|
-
* limitations under the License.
|
|
16
|
-
*/
|
|
17
|
-
export * from './api.standalone';
|
|
18
|
-
export { getDatabase } from './api/Database';
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
* Copyright 2021 Google LLC
|
|
4
|
+
*
|
|
5
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
* you may not use this file except in compliance with the License.
|
|
7
|
+
* You may obtain a copy of the License at
|
|
8
|
+
*
|
|
9
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
*
|
|
11
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
* See the License for the specific language governing permissions and
|
|
15
|
+
* limitations under the License.
|
|
16
|
+
*/
|
|
17
|
+
export * from './api.standalone';
|
|
18
|
+
export { getDatabase } from './api/Database';
|
|
@@ -1,30 +1,30 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @license
|
|
3
|
-
* Copyright 2021 Google LLC
|
|
4
|
-
*
|
|
5
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
-
* you may not use this file except in compliance with the License.
|
|
7
|
-
* You may obtain a copy of the License at
|
|
8
|
-
*
|
|
9
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
-
*
|
|
11
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
-
* See the License for the specific language governing permissions and
|
|
15
|
-
* limitations under the License.
|
|
16
|
-
*/
|
|
17
|
-
export { Database, EmulatorMockTokenOptions, enableLogging, goOffline, goOnline, forceWebSockets, forceLongPolling, connectDatabaseEmulator } from './api/Database';
|
|
18
|
-
export { Query, DatabaseReference, ListenOptions, Unsubscribe, ThenableReference } from './api/Reference';
|
|
19
|
-
export { OnDisconnect } from './api/OnDisconnect';
|
|
20
|
-
export { DataSnapshot, EventType, IteratedDataSnapshot, QueryConstraint, QueryConstraintType, endAt, endBefore, equalTo, get, limitToFirst, limitToLast, off, onChildAdded, onChildChanged, onChildMoved, onChildRemoved, onDisconnect, onValue, orderByChild, orderByKey, orderByPriority, orderByValue, push, query, ref, refFromURL, remove, set, setPriority, setWithPriority, startAfter, startAt, update, child } from './api/Reference_impl';
|
|
21
|
-
export { increment, serverTimestamp } from './api/ServerValue';
|
|
22
|
-
export { runTransaction, TransactionOptions, TransactionResult } from './api/Transaction';
|
|
23
|
-
export { setSDKVersion as _setSDKVersion } from './core/version';
|
|
24
|
-
export { ReferenceImpl as _ReferenceImpl, QueryImpl as _QueryImpl } from './api/Reference_impl';
|
|
25
|
-
export { repoManagerDatabaseFromApp as _repoManagerDatabaseFromApp } from './api/Database';
|
|
26
|
-
export { validatePathString as _validatePathString, validateWritablePath as _validateWritablePath } from './core/util/validation';
|
|
27
|
-
export { UserCallback as _UserCallback } from './core/view/EventRegistration';
|
|
28
|
-
export { QueryParams as _QueryParams } from './core/view/QueryParams';
|
|
29
|
-
export { hijackHash as _TEST_ACCESS_hijackHash, forceRestClient as _TEST_ACCESS_forceRestClient } from './api/test_access';
|
|
30
|
-
export * from './internal/index';
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
* Copyright 2021 Google LLC
|
|
4
|
+
*
|
|
5
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
* you may not use this file except in compliance with the License.
|
|
7
|
+
* You may obtain a copy of the License at
|
|
8
|
+
*
|
|
9
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
*
|
|
11
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
* See the License for the specific language governing permissions and
|
|
15
|
+
* limitations under the License.
|
|
16
|
+
*/
|
|
17
|
+
export { Database, EmulatorMockTokenOptions, enableLogging, goOffline, goOnline, forceWebSockets, forceLongPolling, connectDatabaseEmulator } from './api/Database';
|
|
18
|
+
export { Query, DatabaseReference, ListenOptions, Unsubscribe, ThenableReference } from './api/Reference';
|
|
19
|
+
export { OnDisconnect } from './api/OnDisconnect';
|
|
20
|
+
export { DataSnapshot, EventType, IteratedDataSnapshot, QueryConstraint, QueryConstraintType, endAt, endBefore, equalTo, get, limitToFirst, limitToLast, off, onChildAdded, onChildChanged, onChildMoved, onChildRemoved, onDisconnect, onValue, orderByChild, orderByKey, orderByPriority, orderByValue, push, query, ref, refFromURL, remove, set, setPriority, setWithPriority, startAfter, startAt, update, child } from './api/Reference_impl';
|
|
21
|
+
export { increment, serverTimestamp } from './api/ServerValue';
|
|
22
|
+
export { runTransaction, TransactionOptions, TransactionResult } from './api/Transaction';
|
|
23
|
+
export { setSDKVersion as _setSDKVersion } from './core/version';
|
|
24
|
+
export { ReferenceImpl as _ReferenceImpl, QueryImpl as _QueryImpl } from './api/Reference_impl';
|
|
25
|
+
export { repoManagerDatabaseFromApp as _repoManagerDatabaseFromApp } from './api/Database';
|
|
26
|
+
export { validatePathString as _validatePathString, validateWritablePath as _validateWritablePath } from './core/util/validation';
|
|
27
|
+
export { UserCallback as _UserCallback } from './core/view/EventRegistration';
|
|
28
|
+
export { QueryParams as _QueryParams } from './core/view/QueryParams';
|
|
29
|
+
export { hijackHash as _TEST_ACCESS_hijackHash, forceRestClient as _TEST_ACCESS_forceRestClient } from './api/test_access';
|
|
30
|
+
export * from './internal/index';
|
|
@@ -1,30 +1,30 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @license
|
|
3
|
-
* Copyright 2021 Google LLC
|
|
4
|
-
*
|
|
5
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
-
* you may not use this file except in compliance with the License.
|
|
7
|
-
* You may obtain a copy of the License at
|
|
8
|
-
*
|
|
9
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
-
*
|
|
11
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
-
* See the License for the specific language governing permissions and
|
|
15
|
-
* limitations under the License.
|
|
16
|
-
*/
|
|
17
|
-
import { AppCheckInternalComponentName, AppCheckTokenListener, AppCheckTokenResult } from '@firebase/app-check-interop-types';
|
|
18
|
-
import { Provider } from '@firebase/component';
|
|
19
|
-
/**
|
|
20
|
-
* Abstraction around AppCheck's token fetching capabilities.
|
|
21
|
-
*/
|
|
22
|
-
export declare class AppCheckTokenProvider {
|
|
23
|
-
private appName_;
|
|
24
|
-
private appCheckProvider?;
|
|
25
|
-
private appCheck?;
|
|
26
|
-
constructor(appName_: string, appCheckProvider?: Provider<AppCheckInternalComponentName>);
|
|
27
|
-
getToken(forceRefresh?: boolean): Promise<AppCheckTokenResult>;
|
|
28
|
-
addTokenChangeListener(listener: AppCheckTokenListener): void;
|
|
29
|
-
notifyForInvalidToken(): void;
|
|
30
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
* Copyright 2021 Google LLC
|
|
4
|
+
*
|
|
5
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
* you may not use this file except in compliance with the License.
|
|
7
|
+
* You may obtain a copy of the License at
|
|
8
|
+
*
|
|
9
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
*
|
|
11
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
* See the License for the specific language governing permissions and
|
|
15
|
+
* limitations under the License.
|
|
16
|
+
*/
|
|
17
|
+
import { AppCheckInternalComponentName, AppCheckTokenListener, AppCheckTokenResult } from '@firebase/app-check-interop-types';
|
|
18
|
+
import { Provider } from '@firebase/component';
|
|
19
|
+
/**
|
|
20
|
+
* Abstraction around AppCheck's token fetching capabilities.
|
|
21
|
+
*/
|
|
22
|
+
export declare class AppCheckTokenProvider {
|
|
23
|
+
private appName_;
|
|
24
|
+
private appCheckProvider?;
|
|
25
|
+
private appCheck?;
|
|
26
|
+
constructor(appName_: string, appCheckProvider?: Provider<AppCheckInternalComponentName>);
|
|
27
|
+
getToken(forceRefresh?: boolean): Promise<AppCheckTokenResult>;
|
|
28
|
+
addTokenChangeListener(listener: AppCheckTokenListener): void;
|
|
29
|
+
notifyForInvalidToken(): void;
|
|
30
|
+
}
|
|
@@ -1,49 +1,49 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @license
|
|
3
|
-
* Copyright 2017 Google LLC
|
|
4
|
-
*
|
|
5
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
-
* you may not use this file except in compliance with the License.
|
|
7
|
-
* You may obtain a copy of the License at
|
|
8
|
-
*
|
|
9
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
-
*
|
|
11
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
-
* See the License for the specific language governing permissions and
|
|
15
|
-
* limitations under the License.
|
|
16
|
-
*/
|
|
17
|
-
import { FirebaseAuthTokenData } from '@firebase/app-types/private';
|
|
18
|
-
import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
|
|
19
|
-
import { Provider } from '@firebase/component';
|
|
20
|
-
export interface AuthTokenProvider {
|
|
21
|
-
getToken(forceRefresh: boolean): Promise<FirebaseAuthTokenData>;
|
|
22
|
-
addTokenChangeListener(listener: (token: string | null) => void): void;
|
|
23
|
-
removeTokenChangeListener(listener: (token: string | null) => void): void;
|
|
24
|
-
notifyForInvalidToken(): void;
|
|
25
|
-
}
|
|
26
|
-
/**
|
|
27
|
-
* Abstraction around FirebaseApp's token fetching capabilities.
|
|
28
|
-
*/
|
|
29
|
-
export declare class FirebaseAuthTokenProvider implements AuthTokenProvider {
|
|
30
|
-
private appName_;
|
|
31
|
-
private firebaseOptions_;
|
|
32
|
-
private authProvider_;
|
|
33
|
-
private auth_;
|
|
34
|
-
constructor(appName_: string, firebaseOptions_: object, authProvider_: Provider<FirebaseAuthInternalName>);
|
|
35
|
-
getToken(forceRefresh: boolean): Promise<FirebaseAuthTokenData>;
|
|
36
|
-
addTokenChangeListener(listener: (token: string | null) => void): void;
|
|
37
|
-
removeTokenChangeListener(listener: (token: string | null) => void): void;
|
|
38
|
-
notifyForInvalidToken(): void;
|
|
39
|
-
}
|
|
40
|
-
export declare class EmulatorTokenProvider implements AuthTokenProvider {
|
|
41
|
-
private accessToken;
|
|
42
|
-
/** A string that is treated as an admin access token by the RTDB emulator. Used by Admin SDK. */
|
|
43
|
-
static OWNER: string;
|
|
44
|
-
constructor(accessToken: string);
|
|
45
|
-
getToken(forceRefresh: boolean): Promise<FirebaseAuthTokenData>;
|
|
46
|
-
addTokenChangeListener(listener: (token: string | null) => void): void;
|
|
47
|
-
removeTokenChangeListener(listener: (token: string | null) => void): void;
|
|
48
|
-
notifyForInvalidToken(): void;
|
|
49
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
* Copyright 2017 Google LLC
|
|
4
|
+
*
|
|
5
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
* you may not use this file except in compliance with the License.
|
|
7
|
+
* You may obtain a copy of the License at
|
|
8
|
+
*
|
|
9
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
*
|
|
11
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
* See the License for the specific language governing permissions and
|
|
15
|
+
* limitations under the License.
|
|
16
|
+
*/
|
|
17
|
+
import { FirebaseAuthTokenData } from '@firebase/app-types/private';
|
|
18
|
+
import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
|
|
19
|
+
import { Provider } from '@firebase/component';
|
|
20
|
+
export interface AuthTokenProvider {
|
|
21
|
+
getToken(forceRefresh: boolean): Promise<FirebaseAuthTokenData>;
|
|
22
|
+
addTokenChangeListener(listener: (token: string | null) => void): void;
|
|
23
|
+
removeTokenChangeListener(listener: (token: string | null) => void): void;
|
|
24
|
+
notifyForInvalidToken(): void;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Abstraction around FirebaseApp's token fetching capabilities.
|
|
28
|
+
*/
|
|
29
|
+
export declare class FirebaseAuthTokenProvider implements AuthTokenProvider {
|
|
30
|
+
private appName_;
|
|
31
|
+
private firebaseOptions_;
|
|
32
|
+
private authProvider_;
|
|
33
|
+
private auth_;
|
|
34
|
+
constructor(appName_: string, firebaseOptions_: object, authProvider_: Provider<FirebaseAuthInternalName>);
|
|
35
|
+
getToken(forceRefresh: boolean): Promise<FirebaseAuthTokenData>;
|
|
36
|
+
addTokenChangeListener(listener: (token: string | null) => void): void;
|
|
37
|
+
removeTokenChangeListener(listener: (token: string | null) => void): void;
|
|
38
|
+
notifyForInvalidToken(): void;
|
|
39
|
+
}
|
|
40
|
+
export declare class EmulatorTokenProvider implements AuthTokenProvider {
|
|
41
|
+
private accessToken;
|
|
42
|
+
/** A string that is treated as an admin access token by the RTDB emulator. Used by Admin SDK. */
|
|
43
|
+
static OWNER: string;
|
|
44
|
+
constructor(accessToken: string);
|
|
45
|
+
getToken(forceRefresh: boolean): Promise<FirebaseAuthTokenData>;
|
|
46
|
+
addTokenChangeListener(listener: (token: string | null) => void): void;
|
|
47
|
+
removeTokenChangeListener(listener: (token: string | null) => void): void;
|
|
48
|
+
notifyForInvalidToken(): void;
|
|
49
|
+
}
|