Mark BackgroundSyncPlugin options param as optional (#2656)

* Mark options param optional * BroadcastUpdatePlugin options
GoogleChrome · Nov 6, 2020 · c2eddf4 · c2eddf4
1 parent df93286
commit c2eddf4
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/packages/workbox-background-sync/src/BackgroundSyncPlugin.ts b/packages/workbox-background-sync/src/BackgroundSyncPlugin.ts
@@ -26,7 +26,7 @@ class BackgroundSyncPlugin implements WorkboxPlugin {
    *     [Queue]{@link module:workbox-background-sync.Queue} documentation for
    *     parameter details.
    */
-  constructor(name: string, options: QueueOptions) {
+  constructor(name: string, options?: QueueOptions) {
     this._queue = new Queue(name, options);
   }
 

diff --git a/packages/workbox-broadcast-update/src/BroadcastCacheUpdate.ts b/packages/workbox-broadcast-update/src/BroadcastCacheUpdate.ts
@@ -62,7 +62,7 @@ class BroadcastCacheUpdate {
    * Construct a BroadcastCacheUpdate instance with a specific `channelName` to
    * broadcast messages on
    *
-   * @param {Object} options
+   * @param {Object} [options]
    * @param {Array<string>} [options.headersToCheck=['content-length', 'etag', 'last-modified']]
    *     A list of headers that will be used to determine whether the responses
    *     differ.

diff --git a/packages/workbox-broadcast-update/src/BroadcastUpdatePlugin.ts b/packages/workbox-broadcast-update/src/BroadcastUpdatePlugin.ts
@@ -27,15 +27,15 @@ class BroadcastUpdatePlugin implements WorkboxPlugin {
    * calls its [`notifyIfUpdated()`]{@link module:workbox-broadcast-update.BroadcastCacheUpdate~notifyIfUpdated}
    * method whenever the plugin's `cacheDidUpdate` callback is invoked.
    *
-   * @param {Object} options
+   * @param {Object} [options]
    * @param {Array<string>} [options.headersToCheck=['content-length', 'etag', 'last-modified']]
    *     A list of headers that will be used to determine whether the responses
    *     differ.
    * @param {string} [options.generatePayload] A function whose return value
    *     will be used as the `payload` field in any cache update messages sent
    *     to the window clients.
    */
-  constructor(options: BroadcastCacheUpdateOptions) {
+  constructor(options?: BroadcastCacheUpdateOptions) {
     this._broadcastUpdate = new BroadcastCacheUpdate(options);
   }