1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: add spec for util.deprecate()

Browse Source 
Signed-off-by: Trevor Norris <trev.norris@gmail.com>
This commit is contained in:
Yazhong Liu 2014-05-07 17:48:55 +08:00 committed by Trevor Norris
parent f10fd1ddba
commit a4f2f9ea8a
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/api/util.markdown
View File

@ -257,6 +257,21 @@ through the `constructor.super_` property.
stream.write("It works!"); // Received data: "It works!" stream.write("It works!"); // Received data: "It works!"
## util.deprecate(function, string)
Marks that a method should not be used any more.
exports.puts = exports.deprecate(function() {
for (var i = 0, len = arguments.length; i < len; ++i) {
process.stdout.write(arguments[i] + '\n');
}
}, 'util.puts: Use console.log instead')
It returns a modified function which warns once by default. If
`--no-deprecation` is set then this function is a NO-OP. If
`--throw-deprecation` is set then the application will throw an exception
if the deprecated API is used.
## util.debug(string) ## util.debug(string)
Stability: 0 - Deprecated: use console.error() instead. Stability: 0 - Deprecated: use console.error() instead.