remove deprecated deferOnce, defer and setTimeout

Author: bekzod

README.md

@@ -18,17 +18,17 @@ A priority queue that will efficiently batch, order, reorder and process work; d
 
 `Backburner#run` - execute the passed function and flush any deferred actions
 
-`Backburner#defer` - defer the passed function to run inside the specified queue
+`Backburner#schedule` - defer the passed function to run inside the specified queue
 
-`Backburner#deferOnce` - defer the passed function to run inside the specified queue, only execute it once
+`Backburner#scheduleOnce` - defer the passed function to run inside the specified queue, only execute it once
 
-`Backburner#setTimeout` - execute the passed function in a specified amount of time
+`Backburner#later` - execute the passed function in a specified amount of time
 
 `Backburner#debounce` - execute the passed function in a specified amount of time, reset timer upon additional calls
 
 `Backburner#throttle` - rate-limit the passed function for a specified amount of time
 
-`Backburner#cancel` - cancel a `deferOnce`, `setTimeout`, `debounce` or `throttle`
+`Backburner#cancel` - cancel a `scheduleOnce`, `later`, `debounce` or `throttle`
 
 `Backburner#on` - Add an event callback. Supports the following events:
 

lib/index.ts

@@ -122,9 +122,9 @@ export default class Backburner {
     @return instantiated class DeferredActionQueues
   */
   public begin(): DeferredActionQueues {
-    let options = this.options;
     let previousInstance = this.currentInstance;
     let current;
+    let options = this.options;
 
     if (this._autorun !== null) {
       current = previousInstance;
@@ -236,14 +236,6 @@ export default class Backburner {
     return this._join(target, method, args);
   }
 
-  /**
-   * @deprecated please use schedule instead.
-   */
-  public defer(queueName: string, ...args);
-  public defer() {
-    return this.schedule(...arguments);
-  }
-
   /**
    * Schedule the passed function to run inside the specified queue.
    */
@@ -270,14 +262,6 @@ export default class Backburner {
     return this._ensureInstance().schedule(queueName, null, iteratorDrain, [iterable], false, stack);
   }
 
-  /**
-   * @deprecated please use scheduleOnce instead.
-   */
-  public deferOnce(queueName: string, ...args);
-  public deferOnce() {
-    return this.scheduleOnce(...arguments);
-  }
-
   /**
    * Schedule the passed function to run once inside the specified queue.
    */
@@ -291,14 +275,6 @@ export default class Backburner {
     return this._ensureInstance().schedule(queueName, target, method, args, true, stack);
   }
 
-  /**
-   * @deprecated use later instead.
-   */
-  public setTimeout(...args);
-  public setTimeout() {
-    return this.later(...arguments);
-  }
-
   public later()
   public later(...args) {
     let length = args.length;
@@ -489,7 +465,7 @@ export default class Backburner {
       return this._cancelItem(timer, this._throttlers) || this._cancelItem(timer, this._debouncees);
     } else if (timerType === 'function') { // we're cancelling a setTimeout
       return this._cancelLaterTimer(timer);
-    } else if (timerType === 'object' && timer.queue && timer.method) { // we're cancelling a deferOnce
+    } else if (timerType === 'object' && timer.queue && timer.method) { // we're cancelling a scheduleOnce
       return timer.queue.cancel(timer);
     }
 

tests/cancel-test.ts

@@ -18,7 +18,7 @@ QUnit.test('scheduleOnce', function(assert) {
   });
 });
 
-QUnit.test('setTimeout', function(assert) {
+QUnit.test('later', function(assert) {
   assert.expect(5);
   let done = assert.async();
 
@@ -43,7 +43,7 @@ QUnit.test('setTimeout', function(assert) {
   }, 0);
 });
 
-QUnit.test('setTimeout with multiple pending', function(assert) {
+QUnit.test('later with multiple pending', function(assert) {
   assert.expect(7);
 
   let done = assert.async();
@@ -73,7 +73,7 @@ QUnit.test('setTimeout with multiple pending', function(assert) {
   }, 10);
 });
 
-QUnit.test('setTimeout and creating a new later', function(assert) {
+QUnit.test('later and creating a new later', function(assert) {
   assert.expect(7);
   let done = assert.async();
   let called = false;

tests/configurable-timeout-test.ts

@@ -39,7 +39,7 @@ QUnit.test('We can use a custom setTimeout', function(assert) {
     }
   });
 
-  bb.setTimeout(() => {
+  bb.later(() => {
     assert.ok(bb.options._platform.isFakePlatform, 'we are using the fake platform');
     assert.ok(customNextWasUsed , 'custom later was used');
     done();

tests/index.ts

@@ -4,14 +4,14 @@ import './cancel-test';
 import './configurable-timeout-test';
 import './debounce-test';
 import './debug-test';
-import './defer-iterable-test';
-import './defer-once-test';
-import './defer-test';
 import './events-test';
 import './join-test';
+import './later-test';
 import './multi-turn-test';
 import './queue-push-unique-test';
 import './queue-test';
 import './run-test';
-import './set-timeout-test';
+import './schedule-iterable-test';
+import './schedule-once-test';
+import './schedule-test';
 import './throttle-test';

tests/set-timeout-test.ts renamed to tests/later-test.ts

@@ -3,7 +3,7 @@ import Backburner from 'backburner';
 const originalDateNow = Date.now;
 const originalDateValueOf = Date.prototype.valueOf;
 
-QUnit.module('tests/set-timeout-test', {
+QUnit.module('tests/later-test', {
   afterEach() {
     Date.now = originalDateNow;
     Date.prototype.valueOf = originalDateValueOf;

tests/defer-iterable-test.ts renamed to tests/schedule-iterable-test.ts

@@ -1,6 +1,6 @@
 import Backburner from 'backburner';
 
-QUnit.module('tests/defer-iterable');
+QUnit.module('tests/schedule-iterable');
 
 class Iterator {
   private _collection: Function[];

tests/defer-once-test.ts renamed to tests/schedule-once-test.ts

@@ -1,6 +1,6 @@
 import Backburner from 'backburner';
 
-QUnit.module('tests/defer-once');
+QUnit.module('tests/schedule-once');
 
 QUnit.test('when passed a function', function(assert) {
   assert.expect(1);
@@ -76,7 +76,7 @@ QUnit.test('throws when passed an undefined method', function(assert) {
     onError
   });
 
-  bb.run(() => bb.deferOnce('deferErrors', {zomg: 'hi'}, undefined));
+  bb.run(() => bb.scheduleOnce('deferErrors', {zomg: 'hi'}, undefined));
 });
 
 QUnit.test('throws when passed an method name that does not exists on the target', function(assert) {
@@ -90,7 +90,7 @@ QUnit.test('throws when passed an method name that does not exists on the target
     onError
   });
 
-  bb.run(() => bb.deferOnce('deferErrors', {zomg: 'hi'}, 'checkFunction'));
+  bb.run(() => bb.scheduleOnce('deferErrors', {zomg: 'hi'}, 'checkFunction'));
 });
 
 QUnit.test('when passed a target, method, and arguments', function(assert) {

tests/defer-test.ts renamed to tests/schedule-test.ts

@@ -1,7 +1,7 @@
 import Backburner from 'backburner';
 let originalDateValueOf = Date.prototype.valueOf;
 
-QUnit.module('tests/defer', {
+QUnit.module('tests/schedule', {
   afterEach() {
     Date.prototype.valueOf = originalDateValueOf;
   }