FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: errno is a number, not a string by jvilk · Pull Request #9007 · nodejs/node · GitHub

/ node Public

doc: errno is a number, not a string - #9007

Closed
jvilk wants to merge 1 commit into
nodejs:masterfrom
jvilk:master
ConversationCommits (1)ChecksFiles changed
Closed

doc: errno is a number, not a string#9007
jvilk wants to merge 1 commit into
nodejs:masterfrom
jvilk:master

Conversation

jvilk commented Oct 10, 2016 •
edited
Loading

Copy link
Copy Markdown
Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

Description of change

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.

As proof, here's some code:

fs.readFile("nonexistantdjkfald", function(e) {
  console.log(e.errno); 
  console.log(typeof(e.errno));
  console.log(e.code);
  console.log(typeof(e.code));
});

Output:

-2
number
ENOENT
string

nodejs-github-bot added doc Issues and PRs related to the documentations. errors Issues and PRs related to JavaScript errors originated in Node.js core. labels Oct 10, 2016

jvilk commented Oct 10, 2016

Copy link
Copy Markdown
Author

Note: Since this documentation change is relevant to currently released versions of Node, it should probably be backported to relevant branches.

jvilk mentioned this pull request Oct 10, 2016
Merged
lpinca approved these changes Oct 10, 2016
View reviewed changes

lpinca left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM

gibfahn reviewed Oct 10, 2016
View reviewed changes
Comment thread doc/api/errors.md Outdated

gibfahn Oct 10, 2016

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Maybe Returns a number corresponding to an error code ? LGTM either way.

gibfahn commented Oct 10, 2016

Copy link
Copy Markdown
Member

Also it's a small thing, but if you could wrap your commit message at 72 chars that'd be great.

doc: errno is a number, not a string
a554d59 
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.

jvilk commented Oct 10, 2016

Copy link
Copy Markdown
Author

@gibfahn I have clarified the documentation, and fixed the commit message. Please note that I have added extra information since the last commit. Node negates the error code, so an error code of 2 becomes -2. I hope the new text is understandable; if not, I am open to editing suggestions! :)

lpinca pushed a commit to lpinca/node that referenced this pull request Oct 16, 2016
doc: specify that errno is a number, not a string
f478b46 
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: nodejs#9007
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>

lpinca commented Oct 16, 2016

Copy link
Copy Markdown
Member

Landed in f478b46.
Thank you!

lpinca closed this Oct 16, 2016
jasnell pushed a commit that referenced this pull request Oct 17, 2016
doc: specify that errno is a number, not a string
b0da431 
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: #9007
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
MylesBorins pushed a commit that referenced this pull request Nov 11, 2016
doc: specify that errno is a number, not a string
132425a 
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: #9007
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
MylesBorins pushed a commit that referenced this pull request Nov 11, 2016
doc: specify that errno is a number, not a string
b2a2a57 
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: #9007
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
This was referenced Nov 22, 2016
Merged
Merged
aliscco mentioned this pull request Dec 1, 2023
Open
leonardoadame mentioned this pull request Dec 3, 2023
Open
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

lpinca lpinca approved these changes
+1 more reviewer
gibfahn gibfahn approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

doc Issues and PRs related to the documentations. errors Issues and PRs related to JavaScript errors originated in Node.js core.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

Back | FazBrowse Home | New Git URL