Source: externs/shaka/abortable.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  7. /**
  8.  * @externs
  9.  */
  12. /**
  13.  * A representation of an abortable operation.  Note that these are not
  14.  * cancelable.  Cancelation implies undoing what has been done so far,
  15.  * whereas aborting only means that further work is stopped.
  16.  *
  17.  * @interface
  18.  * @template T
  19.  * @exportDoc
  20.  */
  21. shaka.extern.IAbortableOperation = function() {};
  24. /**
  25.  * A Promise which represents the underlying operation.  It is resolved when
  26.  * the operation is complete, and rejected if the operation fails or is
  27.  * aborted.  Aborted operations should be rejected with a shaka.util.Error
  28.  * object using the error code OPERATION_ABORTED.
  29.  *
  30.  * @const {!Promise.<T>}
  31.  * @exportDoc
  32.  */
  33. shaka.extern.IAbortableOperation.prototype.promise;
  36. /**
  37.  * Can be called by anyone holding this object to abort the underlying
  38.  * operation.  This is not cancelation, and will not necessarily result in
  39.  * any work being undone.  abort() should return a Promise which is resolved
  40.  * when the underlying operation has been aborted.  The returned Promise
  41.  * should never be rejected.
  42.  *
  43.  * @return {!Promise}
  44.  * @exportDoc
  45.  */
  46. shaka.extern.IAbortableOperation.prototype.abort = function() {};
  49. /**
  50.  * @param {function(boolean)} onFinal A callback to be invoked after the
  51.  *   operation succeeds or fails.  The boolean argument is true if the operation
  52.  *   succeeded and false if it failed.
  53.  * @return {!shaka.extern.IAbortableOperation.<T>} Returns this.
  54.  * @exportDoc
  55.  */
  56. shaka.extern.IAbortableOperation.prototype.finally = function(onFinal) {};