Skip to content

Commit a5314a1

Browse files
JungMinuBethGriggs
authored andcommitted
doc: remove old system_errors
Remove old errors_system_errors, any useful information in it moved into the SystemError class docs. Fixes: #26861 PR-URL: #27037 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
1 parent fd8de13 commit a5314a1

File tree

2 files changed

+10
-21
lines changed

2 files changed

+10
-21
lines changed

doc/api/errors.md

+10-20
Original file line numberDiff line numberDiff line change
@@ -355,9 +355,6 @@ The number of frames captured by the stack trace is bounded by the smaller of
355355
`Error.stackTraceLimit` or the number of available frames on the current event
356356
loop tick.
357357

358-
System-level errors are generated as augmented `Error` instances, which are
359-
detailed [here](#errors_system_errors).
360-
361358
## Class: AssertionError
362359

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

445-
## System Errors
442+
## Class: SystemError
446443

447444
Node.js generates system errors when exceptions occur within its runtime
448445
environment. These usually occur when an application violates an operating
449446
system constraint. For example, a system error will occur if an application
450447
attempts to read a file that does not exist.
451448

452-
System errors are usually generated at the syscall level. For a comprehensive
453-
list, see the [`errno`(3) man page][].
454-
455-
In Node.js, system errors are `Error` objects with extra properties.
456-
457-
### Class: SystemError
458-
459449
* `address` {string} If present, the address to which a network connection
460450
failed
461451
* `code` {string} The string error code
@@ -468,27 +458,27 @@ In Node.js, system errors are `Error` objects with extra properties.
468458
* `port` {number} If present, the network connection port that is not available
469459
* `syscall` {string} The name of the system call that triggered the error
470460

471-
#### error.address
461+
### error.address
472462

473463
* {string}
474464

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

478-
#### error.code
468+
### error.code
479469

480470
* {string}
481471

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

484-
#### error.dest
474+
### error.dest
485475

486476
* {string}
487477

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

491-
#### error.errno
481+
### error.errno
492482

493483
* {string|number}
494484

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

501-
#### error.info
491+
### error.info
502492

503493
* {Object}
504494

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

507-
#### error.message
497+
### error.message
508498

509499
* {string}
510500

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

513-
#### error.path
503+
### error.path
514504

515505
* {string}
516506

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

519-
#### error.port
509+
### error.port
520510

521511
* {number}
522512

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

525-
#### error.syscall
515+
### error.syscall
526516

527517
* {string}
528518

doc/api/os.md

-1
Original file line numberDiff line numberDiff line change
@@ -1315,7 +1315,6 @@ The following process scheduling constants are exported by
13151315
</tr>
13161316
</table>
13171317

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

0 commit comments

Comments
 (0)