Skip to content
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.

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

doc: remove old errors_system_errors #26976

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 10 additions & 25 deletions doc/api/errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -355,9 +355,6 @@ The number of frames captured by the stack trace is bounded by the smaller of
`Error.stackTraceLimit` or the number of available frames on the current event
loop tick.

System-level errors are generated as augmented `Error` instances, which are
detailed [here](#errors_system_errors).

## Class: AssertionError

A subclass of `Error` that indicates the failure of an assertion. For details,
Expand Down Expand Up @@ -442,19 +439,7 @@ Some exceptions are *unrecoverable* at the JavaScript layer. Such exceptions
will *always* cause the Node.js process to crash. Examples include `assert()`
checks or `abort()` calls in the C++ layer.

## System Errors

Node.js generates system errors when exceptions occur within its runtime
Copy link
Contributor

Choose a reason for hiding this comment

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

I think these two paragraphs, slightly edited, should be moved to be the description of class SystemError, because the information in them is still useful.

environment. These usually occur when an application violates an operating
system constraint. For example, a system error will occur if an application
attempts to read a file that does not exist.

System errors are usually generated at the syscall level. For a comprehensive
list, see the [`errno`(3) man page][].
Copy link
Member

Choose a reason for hiding this comment

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

Should we really remove the whole description? It still seems partially useful to me?

Copy link
Member Author

Choose a reason for hiding this comment

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

See #26861 for context

Copy link
Contributor

Choose a reason for hiding this comment

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

Didn't see Ruben's comment because it was hidden/resolved. I agree with him.


In Node.js, system errors are `Error` objects with extra properties.

### Class: SystemError
## Class: SystemError

* `address` {string} If present, the address to which a network connection
failed
Expand All @@ -468,27 +453,27 @@ In Node.js, system errors are `Error` objects with extra properties.
* `port` {number} If present, the network connection port that is not available
* `syscall` {string} The name of the system call that triggered the error

#### error.address
### error.address

* {string}

If present, `error.address` is a string describing the address to which a
network connection failed.

#### error.code
### error.code

* {string}

The `error.code` property is a string representing the error code.

#### error.dest
### error.dest

* {string}

If present, `error.dest` is the file path destination when reporting a file
system error.

#### error.errno
### error.errno

* {string|number}

Expand All @@ -498,31 +483,31 @@ negative value which corresponds to the error code defined in
(`deps/uv/include/uv/errno.h` in the Node.js source tree) for details. In case
of a string, it is the same as `error.code`.

#### error.info
### error.info

* {Object}

If present, `error.info` is an object with details about the error condition.

#### error.message
### error.message

* {string}

`error.message` is a system-provided human-readable description of the error.

#### error.path
### error.path

* {string}

If present, `error.path` is a string containing a relevant invalid pathname.

#### error.port
### error.port

* {number}

If present, `error.port` is the network connection port that is not available.

#### error.syscall
### error.syscall

* {string}

Expand Down
1 change: 0 additions & 1 deletion doc/api/os.md
Original file line number Diff line number Diff line change
Expand Up @@ -1315,7 +1315,6 @@ The following process scheduling constants are exported by
</tr>
</table>

[`SystemError`]: errors.html#errors_system_errors
[`process.arch`]: process.html#process_process_arch
[`process.platform`]: process.html#process_process_platform
[Android building]: https://github.com/nodejs/node/blob/master/BUILDING.md#androidandroid-based-devices-eg-firefox-os
Expand Down