Skip to content

doc: correct description of error.stack accessor behavior #61090

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

Open
Renegade334 wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −3
Open

doc: correct description of error.stack accessor behavior #61090

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 8 additions & 3 deletions doc/api/errors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,13 +379,17 @@ The location information will be one of:
represents a call in a user program (using ES module system), or
its dependencies.

The string representing the stack trace is lazily generated when the
`error.stack` property is **accessed**.

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.

`error.stack` is a getter/setter for a hidden internal property which is only
present on builtin `Error` objects (those for which [`Error.isError`][] returns
true). If `error` is not a builtin error object, then the `error.stack` getter
will always return `undefined`, and the setter will do nothing. This can occur
if `error` is an object that has had its prototype set to `Error.prototype`,
but was not constructed by a builtin `Error` constructor.

## Class: `AssertionError`

* Extends: {errors.Error}
Expand Down Expand Up @@ -4381,6 +4385,7 @@ An error occurred trying to allocate memory. This should never happen.
[`ERR_MISSING_MESSAGE_PORT_IN_TRANSFER_LIST`]: #err_missing_message_port_in_transfer_list
[`ERR_MISSING_TRANSFERABLE_IN_TRANSFER_LIST`]: #err_missing_transferable_in_transfer_list
[`ERR_REQUIRE_ASYNC_MODULE`]: #err_require_async_module
[`Error.isError`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/isError
[`EventEmitter`]: events.md#class-eventemitter
[`MessagePort`]: worker_threads.md#class-messageport
[`Object.getPrototypeOf`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/getPrototypeOf
Expand Down
Loading