daohualiuxiang
/
node
mirror of https://github.com/nodejs/node.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add note about 'error' event to docs

pull/22966/head
Ryan Dahl 2010-05-12 10:42:14 -07:00
parent d2cff34fa3
commit ed0c109950
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/api.markdown
View File

@ -223,12 +223,23 @@ is emitted. These functions are called _listeners_.
All EventEmitters emit the event `'newListener'` when new listeners are
added.
When an EventEmitter experiences an error, the typical action is to emit an
`'error'` event. Error events are special--if there is no handler for them
they will print a stack trace and exit the program.
### Event: 'newListener'
`function (event, listener) { }`
This event is made any time someone adds a new listener.
### Event: 'error'
`function (exception) { }`
If an error was encountered, then this event is emitted. This event is
special - when there are no listeners to receive the error Node will
terminate execution and display the exception's stack trace.
### emitter.addListener(event, listener)