BackgroundSyncPlugin.ts 1.2 KB
/*
  Copyright 2018 Google LLC

  Use of this source code is governed by an MIT-style
  license that can be found in the LICENSE file or at
  https://opensource.org/licenses/MIT.
*/

import {WorkboxPlugin} from 'workbox-core/types.js';
import {Queue, QueueOptions} from './Queue.js';
import './_version.js';

/**
 * A class implementing the `fetchDidFail` lifecycle callback. This makes it
 * easier to add failed requests to a background sync Queue.
 *
 * @memberof module:workbox-background-sync
 */
class BackgroundSyncPlugin implements WorkboxPlugin {
  private readonly _queue: Queue;

  /**
   * @param {string} name See the [Queue]{@link module:workbox-background-sync.Queue}
   *     documentation for parameter details.
   * @param {Object} [options] See the
   *     [Queue]{@link module:workbox-background-sync.Queue} documentation for
   *     parameter details.
   */
  constructor(name: string, options: QueueOptions) {
    this._queue = new Queue(name, options);
  }

  /**
   * @param {Object} options
   * @param {Request} options.request
   * @private
   */
  fetchDidFail: WorkboxPlugin['fetchDidFail'] = async ({request}) => {
    await this._queue.pushRequest({request});
  }
}

export {BackgroundSyncPlugin};