Document Promise as an external

jeremyckahn · Oct 10, 2017 · 3c8ecdb · 3c8ecdb
1 parent cb94446
commit 3c8ecdb
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 6 deletions.
diff --git a/src/main.js b/src/main.js
@@ -6,6 +6,11 @@ export { Tweenable, tween } from './tweenable';
 export { interpolate } from './interpolate';
 export { setBezierFunction, unsetBezierFunction } from './bezier';
 
+/**
+ * @external Promise
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise}
+ */
+
 /**
  * @callback {Function} shifty.easingFunction
  * @param {number} position The normalized (0-1) position of the tween.

diff --git a/src/tweenable.js b/src/tweenable.js
@@ -29,9 +29,7 @@ const noop = () => {};
  * @param {Function(string)} fn
  * @private
  */
-export const each = (obj, fn) => {
-  Object.keys(obj).forEach(fn);
-};
+export const each = (obj, fn) => Object.keys(obj).forEach(fn);
 
 /**
  * @param {Object} obj
@@ -236,7 +234,7 @@ export class Tweenable {
    * @method shifty.Tweenable#tween
    * @param {shifty.tweenConfig} [config] Gets passed to {@link
    * shifty.Tweenable#setConfig}
-   * @return {Promise}
+   * @return {external:Promise}
    */
   tween (config = undefined) {
     if (this._isTweening) {
@@ -342,7 +340,7 @@ export class Tweenable {
   /**
    * Resume a paused tween.
    * @method shifty.Tweenable#resume
-   * @return {Promise}
+   * @return {external:Promise}
    */
   resume () {
     if (this._isPaused) {
@@ -493,7 +491,7 @@ assign(Tweenable, {
  *       () => console.log('All done!')
  *     );
  *
- * @returns {Promise}
+ * @returns {external:Promise}
  */
 export function tween (config = {}) {
   const tweenable = new Tweenable();