diff options
| author | John Vilk <jvilk@cs.umass.edu> | 2016-10-10 12:28:49 -0400 |
|---|---|---|
| committer | Luigi Pinca <luigipinca@gmail.com> | 2016-10-16 20:43:21 +0200 |
| commit | f478b46a00cfe6f631fd85012ba2896a9e8bf5db (patch) | |
| tree | 0d36cb1d4b1933e0aa136507a20d84b3e496db83 /doc | |
| parent | f7842ad1698984e978bc414bc359cb5268b953d9 (diff) | |
| download | android-node-v8-f478b46a00cfe6f631fd85012ba2896a9e8bf5db.tar.gz android-node-v8-f478b46a00cfe6f631fd85012ba2896a9e8bf5db.tar.bz2 android-node-v8-f478b46a00cfe6f631fd85012ba2896a9e8bf5db.zip | |
doc: specify that errno is a number, not a string
The documentation erroneously described the errno property as an alias
for the code property, but that is not the case in the implementation.
errno is the error code of the error as a number, and code is the error
code of the error as a string.
PR-URL: https://github.com/nodejs/node/pull/9007
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/errors.md | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/api/errors.md b/doc/api/errors.md index 5ede6e6e38..28f1858a1d 100644 --- a/doc/api/errors.md +++ b/doc/api/errors.md @@ -449,13 +449,15 @@ added properties. ### Class: System Error #### error.code -#### error.errno Returns a string representing the error code, which is always `E` followed by a sequence of capital letters, and may be referenced in `man 2 intro`. -The properties `error.code` and `error.errno` are aliases of one another and -return the same value. +#### error.errno + +Returns a number corresponding to the **negated** error code, which may be +referenced in `man 2 intro`. For example, an `ENOENT` error has an `errno` of +`-2` because the error code for `ENOENT` is `2`. #### error.syscall |