@irrelon/emitter 6.1.0 → 6.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/doc/off.html DELETED
@@ -1,857 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8">
5
- <title>JSDoc: Class: off</title>
6
-
7
- <script src="scripts/prettify/prettify.js"> </script>
8
- <script src="scripts/prettify/lang-css.js"> </script>
9
- <!--[if lt IE 9]>
10
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11
- <![endif]-->
12
- <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13
- <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14
- </head>
15
-
16
- <body>
17
-
18
- <div id="main">
19
-
20
- <h1 class="page-title">Class: off</h1>
21
-
22
-
23
-
24
-
25
-
26
-
27
- <section>
28
-
29
- <header>
30
-
31
- <h2>off</h2>
32
-
33
-
34
- </header>
35
-
36
- <article>
37
- <div class="container-overview">
38
-
39
-
40
-
41
-
42
-
43
- <h4 class="name" id="off"><span class="type-signature"></span>new off<span class="signature">(event, id)</span><span class="type-signature"></span></h4>
44
-
45
-
46
-
47
-
48
-
49
- <div class="description">
50
- Cancels all listeners for an event based on the passed event name and id.
51
- </div>
52
-
53
-
54
-
55
-
56
-
57
-
58
-
59
-
60
-
61
- <h5>Parameters:</h5>
62
-
63
-
64
- <table class="params">
65
- <thead>
66
- <tr>
67
-
68
- <th>Name</th>
69
-
70
-
71
- <th>Type</th>
72
-
73
-
74
-
75
-
76
-
77
- <th class="last">Description</th>
78
- </tr>
79
- </thead>
80
-
81
- <tbody>
82
-
83
-
84
- <tr>
85
-
86
- <td class="name"><code>event</code></td>
87
-
88
-
89
- <td class="type">
90
-
91
-
92
- <span class="param-type">String</span>
93
-
94
-
95
-
96
- </td>
97
-
98
-
99
-
100
-
101
-
102
- <td class="description last">The event name to cancel listeners for.</td>
103
- </tr>
104
-
105
-
106
-
107
- <tr>
108
-
109
- <td class="name"><code>id</code></td>
110
-
111
-
112
- <td class="type">
113
-
114
-
115
- <span class="param-type">*</span>
116
-
117
-
118
-
119
- </td>
120
-
121
-
122
-
123
-
124
-
125
- <td class="description last">The ID to cancel all listeners for.</td>
126
- </tr>
127
-
128
-
129
- </tbody>
130
- </table>
131
-
132
-
133
-
134
-
135
-
136
-
137
- <dl class="details">
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
-
152
-
153
-
154
-
155
-
156
-
157
-
158
-
159
-
160
-
161
-
162
-
163
-
164
- <dt class="tag-source">Source:</dt>
165
- <dd class="tag-source"><ul class="dummy"><li>
166
- <a href="Emitter.js.html">Emitter.js</a>, <a href="Emitter.js.html#line265">line 265</a>
167
- </li></ul></dd>
168
-
169
-
170
-
171
-
172
-
173
-
174
-
175
- </dl>
176
-
177
-
178
-
179
-
180
-
181
-
182
-
183
-
184
-
185
-
186
-
187
-
188
-
189
-
190
-
191
-
192
-
193
- </div>
194
-
195
-
196
-
197
-
198
-
199
-
200
-
201
-
202
-
203
-
204
-
205
-
206
-
207
-
208
-
209
-
210
-
211
-
212
- </article>
213
-
214
- </section>
215
-
216
-
217
-
218
-
219
-
220
-
221
-
222
- <section>
223
-
224
- <header>
225
-
226
- <h2>off</h2>
227
-
228
-
229
- </header>
230
-
231
- <article>
232
- <div class="container-overview">
233
-
234
-
235
-
236
-
237
-
238
- <h4 class="name" id="off"><span class="type-signature"></span>new off<span class="signature">(event, id, listener)</span><span class="type-signature"></span></h4>
239
-
240
-
241
-
242
-
243
-
244
- <div class="description">
245
- Cancels an event listener based on an event name, id and listener function.
246
- </div>
247
-
248
-
249
-
250
-
251
-
252
-
253
-
254
-
255
-
256
- <h5>Parameters:</h5>
257
-
258
-
259
- <table class="params">
260
- <thead>
261
- <tr>
262
-
263
- <th>Name</th>
264
-
265
-
266
- <th>Type</th>
267
-
268
-
269
-
270
-
271
-
272
- <th class="last">Description</th>
273
- </tr>
274
- </thead>
275
-
276
- <tbody>
277
-
278
-
279
- <tr>
280
-
281
- <td class="name"><code>event</code></td>
282
-
283
-
284
- <td class="type">
285
-
286
-
287
- <span class="param-type">String</span>
288
-
289
-
290
-
291
- </td>
292
-
293
-
294
-
295
-
296
-
297
- <td class="description last">The event to cancel listener for.</td>
298
- </tr>
299
-
300
-
301
-
302
- <tr>
303
-
304
- <td class="name"><code>id</code></td>
305
-
306
-
307
- <td class="type">
308
-
309
-
310
- <span class="param-type">String</span>
311
-
312
-
313
-
314
- </td>
315
-
316
-
317
-
318
-
319
-
320
- <td class="description last">The ID of the event to cancel listening for.</td>
321
- </tr>
322
-
323
-
324
-
325
- <tr>
326
-
327
- <td class="name"><code>listener</code></td>
328
-
329
-
330
- <td class="type">
331
-
332
-
333
- <span class="param-type">function</span>
334
-
335
-
336
-
337
- </td>
338
-
339
-
340
-
341
-
342
-
343
- <td class="description last">The event listener function used in the on()
344
- or once() call to cancel.</td>
345
- </tr>
346
-
347
-
348
- </tbody>
349
- </table>
350
-
351
-
352
-
353
-
354
-
355
-
356
- <dl class="details">
357
-
358
-
359
-
360
-
361
-
362
-
363
-
364
-
365
-
366
-
367
-
368
-
369
-
370
-
371
-
372
-
373
-
374
-
375
-
376
-
377
-
378
-
379
-
380
-
381
-
382
-
383
- <dt class="tag-source">Source:</dt>
384
- <dd class="tag-source"><ul class="dummy"><li>
385
- <a href="Emitter.js.html">Emitter.js</a>, <a href="Emitter.js.html#line236">line 236</a>
386
- </li></ul></dd>
387
-
388
-
389
-
390
-
391
-
392
-
393
-
394
- </dl>
395
-
396
-
397
-
398
-
399
-
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
- </div>
413
-
414
-
415
-
416
-
417
-
418
-
419
-
420
-
421
-
422
-
423
-
424
-
425
-
426
-
427
-
428
-
429
-
430
-
431
- </article>
432
-
433
- </section>
434
-
435
-
436
-
437
-
438
-
439
-
440
-
441
- <section>
442
-
443
- <header>
444
-
445
- <h2>off</h2>
446
-
447
-
448
- </header>
449
-
450
- <article>
451
- <div class="container-overview">
452
-
453
-
454
-
455
-
456
-
457
- <h4 class="name" id="off"><span class="type-signature"></span>new off<span class="signature">(event, listener)</span><span class="type-signature"> &rarr; {*}</span></h4>
458
-
459
-
460
-
461
-
462
-
463
- <div class="description">
464
- Cancels the event listener for the passed event and listener function.
465
- </div>
466
-
467
-
468
-
469
-
470
-
471
-
472
-
473
-
474
-
475
- <h5>Parameters:</h5>
476
-
477
-
478
- <table class="params">
479
- <thead>
480
- <tr>
481
-
482
- <th>Name</th>
483
-
484
-
485
- <th>Type</th>
486
-
487
-
488
-
489
-
490
-
491
- <th class="last">Description</th>
492
- </tr>
493
- </thead>
494
-
495
- <tbody>
496
-
497
-
498
- <tr>
499
-
500
- <td class="name"><code>event</code></td>
501
-
502
-
503
- <td class="type">
504
-
505
-
506
- <span class="param-type">String</span>
507
-
508
-
509
-
510
- </td>
511
-
512
-
513
-
514
-
515
-
516
- <td class="description last">The event to cancel listener for.</td>
517
- </tr>
518
-
519
-
520
-
521
- <tr>
522
-
523
- <td class="name"><code>listener</code></td>
524
-
525
-
526
- <td class="type">
527
-
528
-
529
- <span class="param-type">function</span>
530
-
531
-
532
-
533
- </td>
534
-
535
-
536
-
537
-
538
-
539
- <td class="description last">The event listener function used in the on()
540
- or once() call to cancel.</td>
541
- </tr>
542
-
543
-
544
- </tbody>
545
- </table>
546
-
547
-
548
-
549
-
550
-
551
-
552
- <dl class="details">
553
-
554
-
555
-
556
-
557
-
558
-
559
-
560
-
561
-
562
-
563
-
564
-
565
-
566
-
567
-
568
-
569
-
570
-
571
-
572
-
573
-
574
-
575
-
576
-
577
-
578
-
579
- <dt class="tag-source">Source:</dt>
580
- <dd class="tag-source"><ul class="dummy"><li>
581
- <a href="Emitter.js.html">Emitter.js</a>, <a href="Emitter.js.html#line197">line 197</a>
582
- </li></ul></dd>
583
-
584
-
585
-
586
-
587
-
588
-
589
-
590
- </dl>
591
-
592
-
593
-
594
-
595
-
596
-
597
-
598
-
599
-
600
-
601
-
602
-
603
-
604
- <h5>Returns:</h5>
605
-
606
-
607
-
608
-
609
- <dl>
610
- <dt>
611
- Type
612
- </dt>
613
- <dd>
614
-
615
- <span class="param-type">*</span>
616
-
617
-
618
- </dd>
619
- </dl>
620
-
621
-
622
-
623
-
624
-
625
-
626
- </div>
627
-
628
-
629
-
630
-
631
-
632
-
633
-
634
-
635
-
636
-
637
-
638
-
639
-
640
-
641
-
642
-
643
-
644
-
645
- </article>
646
-
647
- </section>
648
-
649
-
650
-
651
-
652
-
653
-
654
-
655
- <section>
656
-
657
- <header>
658
-
659
- <h2>off</h2>
660
-
661
-
662
- </header>
663
-
664
- <article>
665
- <div class="container-overview">
666
-
667
-
668
-
669
-
670
-
671
- <h4 class="name" id="off"><span class="type-signature"></span>new off<span class="signature">(event)</span><span class="type-signature"> &rarr; {*}</span></h4>
672
-
673
-
674
-
675
-
676
-
677
- <div class="description">
678
- Cancels all event listeners for the passed event.
679
- </div>
680
-
681
-
682
-
683
-
684
-
685
-
686
-
687
-
688
-
689
- <h5>Parameters:</h5>
690
-
691
-
692
- <table class="params">
693
- <thead>
694
- <tr>
695
-
696
- <th>Name</th>
697
-
698
-
699
- <th>Type</th>
700
-
701
-
702
-
703
-
704
-
705
- <th class="last">Description</th>
706
- </tr>
707
- </thead>
708
-
709
- <tbody>
710
-
711
-
712
- <tr>
713
-
714
- <td class="name"><code>event</code></td>
715
-
716
-
717
- <td class="type">
718
-
719
-
720
- <span class="param-type">String</span>
721
-
722
-
723
-
724
- </td>
725
-
726
-
727
-
728
-
729
-
730
- <td class="description last">The name of the event.</td>
731
- </tr>
732
-
733
-
734
- </tbody>
735
- </table>
736
-
737
-
738
-
739
-
740
-
741
-
742
- <dl class="details">
743
-
744
-
745
-
746
-
747
-
748
-
749
-
750
-
751
-
752
-
753
-
754
-
755
-
756
-
757
-
758
-
759
-
760
-
761
-
762
-
763
-
764
-
765
-
766
-
767
-
768
-
769
- <dt class="tag-source">Source:</dt>
770
- <dd class="tag-source"><ul class="dummy"><li>
771
- <a href="Emitter.js.html">Emitter.js</a>, <a href="Emitter.js.html#line173">line 173</a>
772
- </li></ul></dd>
773
-
774
-
775
-
776
-
777
-
778
-
779
-
780
- </dl>
781
-
782
-
783
-
784
-
785
-
786
-
787
-
788
-
789
-
790
-
791
-
792
-
793
-
794
- <h5>Returns:</h5>
795
-
796
-
797
-
798
-
799
- <dl>
800
- <dt>
801
- Type
802
- </dt>
803
- <dd>
804
-
805
- <span class="param-type">*</span>
806
-
807
-
808
- </dd>
809
- </dl>
810
-
811
-
812
-
813
-
814
-
815
-
816
- </div>
817
-
818
-
819
-
820
-
821
-
822
-
823
-
824
-
825
-
826
-
827
-
828
-
829
-
830
-
831
-
832
-
833
-
834
-
835
- </article>
836
-
837
- </section>
838
-
839
-
840
-
841
-
842
- </div>
843
-
844
- <nav>
845
- <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="deferEmit.html">deferEmit</a></li><li><a href="global.html#emit">emit</a></li><li><a href="emitStatic.html">emitStatic</a></li><li><a href="emitStaticId.html">emitStaticId</a></li><li><a href="off.html">off</a></li><li><a href="on.html">on</a></li><li><a href="once.html">once</a></li><li><a href="willEmit.html">willEmit</a></li><li><a href="willEmitId.html">willEmitId</a></li></ul><h3>Global</h3><ul><li><a href="global.html#$main">$main</a></li></ul>
846
- </nav>
847
-
848
- <br class="clear">
849
-
850
- <footer>
851
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Oct 30 2017 16:01:17 GMT+0000 (GMT)
852
- </footer>
853
-
854
- <script> prettyPrint(); </script>
855
- <script src="scripts/linenumber.js"> </script>
856
- </body>
857
- </html>