mirror of
https://github.com/nodejs/node.git
synced 2026-11-21 12:59:16 -05:00
doc, test: symbols as event names
* Document that Symbol can used as event names. * Add test for using Symbol as event names PR-URL: https://github.com/nodejs/node/pull/4151 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
1 parent
89ec01389b
commit
27a1e14a8a
2 files changed
+27
-3
No files matched your search
@@ -10,7 +10,8 @@ is opened. All objects which emit events are instances of `events.EventEmitter`.
|
||||
You can access this module by doing: `require("events");`
|
||||
|
||||
Typically, event names are represented by a camel-cased string, however,
|
||||
there aren't any strict restrictions on that, as any string will be accepted.
|
||||
there aren't any strict restrictions on that, as any valid property key will be
|
||||
accepted.
|
||||
|
||||
Functions can then be attached to objects, to be executed when an event
|
||||
is emitted. These functions are called _listeners_. Inside a listener
|
||||
@@ -59,7 +60,7 @@ Returns the number of listeners for a given event.
|
||||
|
||||
### Event: 'newListener'
|
||||
|
||||
* `event` {String} The event name
|
||||
* `event` {String|Symbol} The event name
|
||||
* `listener` {Function} The event handler function
|
||||
|
||||
This event is emitted *before* a listener is added. When this event is
|
||||
@@ -70,7 +71,7 @@ added.
|
||||
|
||||
### Event: 'removeListener'
|
||||
|
||||
* `event` {String} The event name
|
||||
* `event` {String|Symbol} The event name
|
||||
* `listener` {Function} The event handler function
|
||||
|
||||
This event is emitted *after* a listener is removed. When this event is
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
'use strict';
|
||||
|
||||
const common = require('../common');
|
||||
const EventEmitter = require('events');
|
||||
const assert = require('assert');
|
||||
|
||||
const ee = new EventEmitter();
|
||||
const foo = Symbol('foo');
|
||||
const listener = common.mustCall(function() {});
|
||||
|
||||
ee.on(foo, listener);
|
||||
assert.deepEqual(ee.listeners(foo), [listener]);
|
||||
|
||||
ee.emit(foo);
|
||||
|
||||
ee.removeAllListeners();
|
||||
assert.deepEqual(ee.listeners(foo), []);
|
||||
|
||||
ee.on(foo, listener);
|
||||
assert.deepEqual(ee.listeners(foo), [listener]);
|
||||
|
||||
ee.removeListener(foo, listener);
|
||||
assert.deepEqual(ee.listeners(foo), []);
|
||||
Reference in new issue
Block a user