0
0
mirror of https://github.com/nodejs/node.git synced 2024-11-29 15:06:33 +01:00
nodejs/doc/api/events.markdown

83 lines
2.5 KiB
Markdown
Raw Normal View History

## Events
2010-10-28 14:18:16 +02:00
Many objects in Node emit events: a `net.Server` emits an event each time
a peer connects to it, a `fs.readStream` emits an event when the file is
opened. All objects which emit events are instances of `events.EventEmitter`.
You can access this module by doing: `require("events");`
2010-10-28 14:18:16 +02:00
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.
2010-10-28 14:18:16 +02:00
Functions can be then be attached to objects, to be executed when an event
is emitted. These functions are called _listeners_.
### events.EventEmitter
2010-10-28 14:18:16 +02:00
To access the EventEmitter class, `require('events').EventEmitter`.
2010-10-28 14:18:16 +02:00
When an `EventEmitter` instance experiences an error, the typical action is
to emit an `'error'` event. Error events are treated as a special case in node.
If there is no listener for it, then the default action is to print a stack
trace and exit the program.
2010-10-28 14:18:16 +02:00
All EventEmitters emit the event `'newListener'` when new listeners are
added.
2010-10-28 14:18:16 +02:00
#### emitter.addListener(event, listener)
#### emitter.on(event, listener)
2010-10-28 14:18:16 +02:00
Adds a listener to the end of the listeners array for the specified event.
server.on('connection', function (stream) {
console.log('someone connected!');
});
2010-10-28 14:18:16 +02:00
#### emitter.once(event, listener)
2010-10-28 14:18:16 +02:00
Adds a **one time** listener for the event. The listener is
invoked only the first time the event is fired, after which
it is removed.
server.once('connection', function (stream) {
console.log('Ah, we have our first user!');
});
2010-10-28 14:18:16 +02:00
#### emitter.removeListener(event, listener)
2010-10-28 14:18:16 +02:00
Remove a listener from the listener array for the specified event.
**Caution**: changes array indices in the listener array behind the listener.
var callback = function(stream) {
console.log('someone connected!');
2010-10-28 14:18:16 +02:00
};
server.on('connection', callback);
2010-10-28 14:18:16 +02:00
// ...
server.removeListener('connection', callback);
#### emitter.removeAllListeners(event)
2010-10-28 14:18:16 +02:00
Removes all listeners from the listener array for the specified event.
#### emitter.listeners(event)
2010-10-28 14:18:16 +02:00
Returns an array of listeners for the specified event. This array can be
manipulated, e.g. to remove listeners.
server.on('connection', function (stream) {
console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')); // [ [Function] ]
2010-10-28 14:18:16 +02:00
#### emitter.emit(event, [arg1], [arg2], [...])
2010-10-28 14:18:16 +02:00
Execute each of the listeners in order with the supplied arguments.
#### Event: 'newListener'
`function (event, listener) { }`
This event is emitted any time someone adds a new listener.