Reference for de-facto interoperable V8 Stack trace API props #38048

Josh-Cena · 2025-02-08T08:09:50Z

Part of #37930.

I'm not documenting prepareStackTrace because (a) it's only supported by V8 (b) it's too big and complex and prone to changes.

github-actions · 2025-02-08T08:11:12Z

Preview URLs

Flaws (3)

Note! 2 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Error
Title: Error
Flaw count: 2

broken_links:
- /en-US/docs/Glossary/serializable_object is ill cased
macros:
- Macro produces link /en-US/docs/Glossary/serializable_object which is a redirect

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/captureStackTrace
Title: Error.captureStackTrace()
Flaw count: 1

macros:
- Macro produces link /en-US/docs/Web/API/console/trace which is a redirect

External URLs (4)

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Error
Title: Error

https://v8.dev/docs/stack-trace-api (2 times) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/stack
Title: Error.prototype.stack

https://v8.dev/docs/stack-trace-api (2 times) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/captureStackTrace
Title: Error.captureStackTrace()

https://v8.dev/docs/stack-trace-api (2 times) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/stackTraceLimit
Title: Error.stackTraceLimit

https://v8.dev/docs/stack-trace-api (2 times) (Note! This may be a new URL 👀)

(comment last updated: 2025-02-10 01:37:28)

hamishwillee · 2025-02-10T00:53:18Z

files/en-us/web/javascript/reference/global_objects/error/index.md

-  - : A non-standard V8 numerical property that limits how many stack frames to include in an error stacktrace.
- `Error.prepareStackTrace()` {{non-standard_inline}} {{optional_inline}}
-  - : A non-standard V8 function that, if provided by user code, is called by the V8 JavaScript engine for thrown exceptions, allowing the user to provide custom formatting for stacktraces.
+- {{jsxref("Error.captureStackTrace()")}} {{non-standard_inline}}


There is now https://github.com/mgaudet/proposal-error-capturestacktrace - at what point does a proposal create enough of a spec that we can start saying this is on the standards track?

It will be proposed for standards track at the February TC39 meeting. It will be standards track after its acceptance.

files/en-us/web/javascript/reference/global_objects/error/capturestacktrace/index.md

files/en-us/web/javascript/reference/global_objects/error/stacktracelimit/index.md

files/en-us/web/javascript/reference/global_objects/error/index.md

Co-authored-by: Hamish Willee <hamishwillee@gmail.com>

hamishwillee · 2025-02-10T02:38:34Z

files/en-us/web/javascript/reference/global_objects/error/capturestacktrace/index.md

@@ -10,7 +10,7 @@ browser-compat: javascript.builtins.Error.captureStackTrace
 {{JSRef}}{{Non-standard_Header}}

 > [!NOTE]
-> This feature is part of the currently non-standard [V8 stack trace API](https://v8.dev/docs/stack-trace-api). However, due to compatibility reasons, it is de facto implemented by all major JavaScript engines.
+> This feature is part of the non-standard [V8 stack trace API](https://v8.dev/docs/stack-trace-api). However, for compatibility reasons, it is de facto implemented by all major JavaScript engines.

 The **`Error.captureStackTrace()`** static method installs stack trace information on a provided object as the [`stack`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/stack) property.


@Josh-Cena Just remembered one more thing - somewhere here we should mention that the stacktrace is not the entire stack - its some amount that is considered relevant to users. Then cross link to say that if Error.stackTraceLimit is supported that can be used to set the max size of the returned stack.

I think this is implied by "follows the same format as {{jsxref("Error.prototype.stack")}}". The reason I want to be handwavy about it is because Firefox doesn't support stackTraceLimit and doesn't plan to, so in FF the stack is uncustomizable anyway.

Fair enough. I would have added something anyway, but your call.

hamishwillee

Looks good. Thanks so much for this! Approving.

Josh-Cena requested a review from a team as a code owner February 8, 2025 08:09

Josh-Cena requested review from sideshowbarker and hamishwillee and removed request for a team and sideshowbarker February 8, 2025 08:09

github-actions bot added Content:JS JavaScript docs size/m [PR only] 51-500 LoC changed labels Feb 8, 2025

Reference for de-facto interoperable V8 Stack trace API props

7f6620e

Josh-Cena force-pushed the error-stack branch from a729dcb to 7f6620e Compare February 8, 2025 16:37