New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: is the stability guarantee of err.code documented anywhere? #23975

Closed

joyeecheung opened this issue Oct 30, 2018 · 3 comments

Assignees

Labels

doc errors

Member

joyeecheung commented Oct 30, 2018 •

edited

Loading

Surprisingly I cannot find in any significant places in https://github.com/nodejs/node/blob/master/doc/api/errors.md that err.code provides a stronger stability guarantee and should be preferred over parsing err.mesage. Am I missing something?

This is something that a lot of Node.js collaborators know, I am sure, but if we don't put it in a significant place in the docs (e.g. with examples), the users may not be able to be sure about that.

The text was updated successfully, but these errors were encountered:

joyeecheung added doc errors labels

Member

Trott commented Nov 4, 2018

That whole section of the docs can use a pretty massive cleanup. I'm on it.

Trott self-assigned this

Trott mentioned this issue

doc: update System Errors documentation #24090

Closed

3 tasks

Member

Trott commented Nov 4, 2018

Trott added a commit to Trott/io.js that referenced this issue


          doc: add text about error.code stability

e027cdb

Fixes: nodejs#23975

Trott added a commit to Trott/io.js that referenced this issue


          doc: update System Errors documentation

366f9b9

Simplify text. Add explanation that `code` is the most stable way to
identify an error, in contrast with `message` which is subject to change
between patch-level versions of Node.js. Synchronize list of properties
with text. Order properties alphabetically.

PR-URL: nodejs#24090
Fixes: nodejs#23975
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

Trott added a commit to Trott/io.js that referenced this issue


          doc: add text about error.code stability

1368eb8

Fixes: nodejs#23975

PR-URL: nodejs#24090
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

Member

Trott commented Nov 7, 2018

Fixed in 1368eb8

Trott closed this as completed

BridgeAR pushed a commit that referenced this issue


          doc: update System Errors documentation

2143b56

Simplify text. Add explanation that `code` is the most stable way to
identify an error, in contrast with `message` which is subject to change
between patch-level versions of Node.js. Synchronize list of properties
with text. Order properties alphabetically.

PR-URL: #24090
Fixes: #23975
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

BridgeAR pushed a commit that referenced this issue


          doc: add text about error.code stability

161be13

Fixes: #23975

PR-URL: #24090
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

kiyomizumia pushed a commit to kiyomizumia/node that referenced this issue


          doc: update System Errors documentation

e9433fc

Simplify text. Add explanation that `code` is the most stable way to
identify an error, in contrast with `message` which is subject to change
between patch-level versions of Node.js. Synchronize list of properties
with text. Order properties alphabetically.

PR-URL: nodejs#24090
Fixes: nodejs#23975
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

kiyomizumia pushed a commit to kiyomizumia/node that referenced this issue


          doc: add text about error.code stability

b30a136

Fixes: nodejs#23975

PR-URL: nodejs#24090
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

codebytere pushed a commit that referenced this issue


          doc: update System Errors documentation

d266f56

Simplify text. Add explanation that `code` is the most stable way to
identify an error, in contrast with `message` which is subject to change
between patch-level versions of Node.js. Synchronize list of properties
with text. Order properties alphabetically.

PR-URL: #24090
Fixes: #23975
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

codebytere pushed a commit that referenced this issue


          doc: add text about error.code stability

e42961f

Fixes: #23975

PR-URL: #24090
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

MylesBorins pushed a commit that referenced this issue


          doc: update System Errors documentation

3102bce

Simplify text. Add explanation that `code` is the most stable way to
identify an error, in contrast with `message` which is subject to change
between patch-level versions of Node.js. Synchronize list of properties
with text. Order properties alphabetically.

PR-URL: #24090
Fixes: #23975
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

MylesBorins pushed a commit that referenced this issue


          doc: add text about error.code stability

c4e34cc

Fixes: #23975

PR-URL: #24090
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

MylesBorins pushed a commit that referenced this issue


          doc: update System Errors documentation

2659a43

Simplify text. Add explanation that `code` is the most stable way to
identify an error, in contrast with `message` which is subject to change
between patch-level versions of Node.js. Synchronize list of properties
with text. Order properties alphabetically.

PR-URL: #24090
Fixes: #23975
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

MylesBorins pushed a commit that referenced this issue


          doc: add text about error.code stability

5fae450

Fixes: #23975

PR-URL: #24090
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment