Skip to content

Commit fbefebe

Browse files
author
Matt Gaunt
authored
Fixing docs for bg sync and moving to namespace (GoogleChrome#1030)
* Fixing docs for bg sync and moving to namespace * Update jsdoc.conf
1 parent cf2ba1d commit fbefebe

File tree

4 files changed

+11
-4
lines changed

4 files changed

+11
-4
lines changed

packages/workbox-background-sync/Queue.mjs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ const queueNames = new Set();
2727
* later. All parts of the storing and replaying process are observable via
2828
* callbacks.
2929
*
30-
* @memberof module:workbox-background-sync
30+
* @memberof workbox.backgroundSync
3131
*/
3232
class Queue {
3333
/**
@@ -196,8 +196,9 @@ class Queue {
196196
* Returns the set of queue names. This is primarily used to reset the list
197197
* of queue names in tests.
198198
*
199-
* @private
200199
* @return {Set}
200+
*
201+
* @private
201202
*/
202203
static get _queueNames() {
203204
return queueNames;

packages/workbox-background-sync/QueuePlugin.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import './_version.mjs';
1919
* A class implementing the `fetchDidFail` lifecycle callback. This makes it
2020
* easier to add failed requests to a background sync Queue.
2121
*
22-
* @memberof module:workbox-background-sync
22+
* @memberof workbox.backgroundSync
2323
*/
2424
class QueuePlugin {
2525
/**

packages/workbox-background-sync/index.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
import './_version.mjs';
1717

1818
/**
19-
* @module workbox-background-sync
19+
* @namespace workbox.backgroundSync
2020
*/
2121

2222
export * from './_public.mjs';

packages/workbox-background-sync/models/QueueStore.mjs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ export class QueueStore {
3030
* identified by their queue name.
3131
*
3232
* @param {Queue} queue
33+
*
34+
* @private
3335
*/
3436
constructor(queue) {
3537
this._queue = queue;
@@ -45,6 +47,8 @@ export class QueueStore {
4547
* as an entry in the object store.
4648
*
4749
* @param {StorableRequest} storableRequest
50+
*
51+
* @private
4852
*/
4953
async addEntry(storableRequest) {
5054
await this._db.add(OBJECT_STORE_NAME, {
@@ -59,6 +63,8 @@ export class QueueStore {
5963
* undefined.
6064
*
6165
* @return {StorableRequest|undefined}
66+
*
67+
* @private
6268
*/
6369
async getAndRemoveOldestEntry() {
6470
const [entry] = await this._db.getAllMatching(OBJECT_STORE_NAME, {

0 commit comments

Comments
 (0)