File tree 2 files changed +10
-3
lines changed
2 files changed +10
-3
lines changed Original file line number Diff line number Diff line change @@ -19,7 +19,7 @@ import { Firestore } from './src/api/database';
19
19
import { loadBundle , namedQuery } from './src/api/bundle' ;
20
20
21
21
/**
22
- * Registers the memory-only Firestore build with the components framework.
22
+ * Registers Firestore bundle loading features with the components framework.
23
23
*/
24
24
export function registerBundle ( instance : typeof Firestore ) : void {
25
25
instance . prototype . loadBundle = function (
@@ -34,8 +34,6 @@ export function registerBundle(instance: typeof Firestore): void {
34
34
) {
35
35
return namedQuery ( this , queryName ) ;
36
36
} ;
37
-
38
- //TODO(wuandy): add loadBundle and namedQuery to the firestore namespace
39
37
}
40
38
41
39
registerBundle ( Firestore ) ;
Original file line number Diff line number Diff line change @@ -26,8 +26,15 @@ import { SnapshotVersion } from './snapshot_version';
26
26
* Represents a Firestore bundle saved by the SDK in its local storage.
27
27
*/
28
28
export interface Bundle {
29
+ /**
30
+ * Id of the bundle. It is used together with `createTime` to determine if a
31
+ * bundle has been loaded by the SDK.
32
+ */
29
33
readonly id : string ;
34
+
35
+ /** Schema version of the bundle. */
30
36
readonly version : number ;
37
+
31
38
/**
32
39
* Set to the snapshot version of the bundle if created by the Server SDKs.
33
40
* Otherwise set to SnapshotVersion.MIN.
@@ -39,7 +46,9 @@ export interface Bundle {
39
46
* Represents a Query saved by the SDK in its local storage.
40
47
*/
41
48
export interface NamedQuery {
49
+ /** The name of the query. */
42
50
readonly name : string ;
51
+ /** The underlying query associated with `name`. */
43
52
readonly query : Query ;
44
53
/** The time at which the results for this query were read. */
45
54
readonly readTime : SnapshotVersion ;
You can’t perform that action at this time.
0 commit comments