mirror of
https://github.com/shaka-project/shaka-player.git
synced 2026-06-14 15:56:38 +03:00
Joey Parrish
562a2d567b
This enables the eslint rule requiring jsdocs on all class
declarations, function declarations, and methods.
Unfortunately, there are two problems with this:
1. We don't use class _declarations_, we use class _expressions_,
which are not covered by this rule. So it does not enforce jsdoc at
the class level.
2. We tend to document a class at the class-level, rather than at the
constructor. But a constructor counts as a method for eslint, so it
requires docs on the constructor. There is no way to configure it to
make an exception for trivial constructors.
So for all trivial (no-argument) constructors, we add empty jsdocs:
/** */
constructor() {
This was quicker and easier than setting up some alternative plugin in
eslint to make an exception for us.
The good news is that this rule caught several undocumented parameters
and places where the jsdoc comment was malformed. So fixing those
also improves the compiler's ability to enforce types.
Change-Id: Icbc46ed690c94e53d354648a883119524f8fca45
53 lines
1.3 KiB
JavaScript
53 lines
1.3 KiB
JavaScript
/*! @license
|
|
* Shaka Player
|
|
* Copyright 2016 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
goog.provide('shaka.util.OperationManager');
|
|
|
|
goog.require('shaka.util.ArrayUtils');
|
|
goog.require('shaka.util.IDestroyable');
|
|
|
|
/**
|
|
* A utility for cleaning up AbortableOperations, to help simplify common
|
|
* patterns and reduce code duplication.
|
|
*
|
|
* @implements {shaka.util.IDestroyable}
|
|
*/
|
|
shaka.util.OperationManager = class {
|
|
/** */
|
|
constructor() {
|
|
/** @private {!Array.<!shaka.extern.IAbortableOperation>} */
|
|
this.operations_ = [];
|
|
}
|
|
|
|
/**
|
|
* Manage an operation. This means aborting it on destroy() and removing it
|
|
* from the management set when it complete.
|
|
*
|
|
* @param {!shaka.extern.IAbortableOperation} operation
|
|
*/
|
|
manage(operation) {
|
|
this.operations_.push(operation.finally(() => {
|
|
shaka.util.ArrayUtils.remove(this.operations_, operation);
|
|
}));
|
|
}
|
|
|
|
/** @override */
|
|
destroy() {
|
|
const cleanup = [];
|
|
for (const op of this.operations_) {
|
|
// Catch and ignore any failures. This silences error logs in the
|
|
// JavaScript console about uncaught Promise failures.
|
|
op.promise.catch(() => {});
|
|
|
|
// Now abort the operation.
|
|
cleanup.push(op.abort());
|
|
}
|
|
|
|
this.operations_ = [];
|
|
return Promise.all(cleanup);
|
|
}
|
|
};
|