Skip to content

Commit 3f83901

Browse files
committed
More accurate and complete comments.
1 parent 571ddcf commit 3f83901

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

packages/firestore/index.bundle.ts

+1-3
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import { Firestore } from './src/api/database';
1919
import { loadBundle, namedQuery } from './src/api/bundle';
2020

2121
/**
22-
* Registers the memory-only Firestore build with the components framework.
22+
* Registers Firestore bundle loading features with the components framework.
2323
*/
2424
export function registerBundle(instance: typeof Firestore): void {
2525
instance.prototype.loadBundle = function (
@@ -34,8 +34,6 @@ export function registerBundle(instance: typeof Firestore): void {
3434
) {
3535
return namedQuery(this, queryName);
3636
};
37-
38-
//TODO(wuandy): add loadBundle and namedQuery to the firestore namespace
3937
}
4038

4139
registerBundle(Firestore);

packages/firestore/src/core/bundle_types.ts

+9
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,15 @@ import { SnapshotVersion } from './snapshot_version';
2626
* Represents a Firestore bundle saved by the SDK in its local storage.
2727
*/
2828
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+
*/
2933
readonly id: string;
34+
35+
/** Schema version of the bundle. */
3036
readonly version: number;
37+
3138
/**
3239
* Set to the snapshot version of the bundle if created by the Server SDKs.
3340
* Otherwise set to SnapshotVersion.MIN.
@@ -39,7 +46,9 @@ export interface Bundle {
3946
* Represents a Query saved by the SDK in its local storage.
4047
*/
4148
export interface NamedQuery {
49+
/** The name of the query. */
4250
readonly name: string;
51+
/** The underlying query associated with `name`. */
4352
readonly query: Query;
4453
/** The time at which the results for this query were read. */
4554
readonly readTime: SnapshotVersion;

0 commit comments

Comments
 (0)