Skip to content

Commit bb81bad

Browse files
committed
Add comments to startOrStopScheduler() to clarify the meaning of isPrimary
1 parent 4a619f6 commit bb81bad

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

packages/firestore/src/core/component_provider.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -354,6 +354,14 @@ export class MultiTabOfflineComponentProvider extends IndexedDbOfflineComponentP
354354
});
355355
}
356356

357+
/**
358+
* Starts or stops a scheduler, taking into account its nullness and whether
359+
* the SDK is acting as the "primary" tab.
360+
* @param scheduler The scheduler to start or stop; if null, then this
361+
* method does nothing.
362+
* @param isPrimary true if the current tab is the primary tab, and false if
363+
* it is a secondary tab.
364+
*/
357365
private startOrStopScheduler(
358366
scheduler: Scheduler | null,
359367
isPrimary: boolean

0 commit comments

Comments
 (0)