Function

cancel (timer) Boolean public

Module: @ember/runloop

Defined in packages/@ember/runloop/index.ts:700 

import { cancel } from '@ember/runloop';
timer
Object
Timer object to cancel
returns
Boolean
true if canceled or false/undefined if it wasn't found

Cancels a scheduled item. Must be a value returned by later(), once(), scheduleOnce(), next(), debounce(), or throttle().

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

import {
  next,
  cancel,
  later,
  scheduleOnce,
  once,
  throttle,
  debounce
} from '@ember/runloop';

let runNext = next(myContext, function() {
  // will not be executed
});

cancel(runNext);

let runLater = later(myContext, function() {
  // will not be executed
}, 500);

cancel(runLater);

let runScheduleOnce = scheduleOnce('afterRender', myContext, function() {
  // will not be executed
});

cancel(runScheduleOnce);

let runOnce = once(myContext, function() {
  // will not be executed
});

cancel(runOnce);

let throttle = throttle(myContext, function() {
  // will not be executed
}, 1, false);

cancel(throttle);

let debounce = debounce(myContext, function() {
  // will not be executed
}, 1);

cancel(debounce);

let debounceImmediate = debounce(myContext, function() {
  // will be executed since we passed in true (immediate)
}, 100, true);

// the 100ms delay until this method can be called again will be canceled
cancel(debounceImmediate);