chore: update docs

This commit is contained in:
Luan
2025-07-22 16:53:42 -03:00
parent 4ae0cc5c52
commit ccd6423183
819 changed files with 10340 additions and 7971 deletions

View File

@@ -108,11 +108,101 @@ node\_modules/typescript/lib/lib.es5.d.ts:1078
***
### prepareStackTrace()?
### stackTraceLimit
> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any`
> `static` **stackTraceLimit**: `number`
Optional override for formatting stack traces
The `Error.stackTraceLimit` property specifies the number of stack frames
collected by a stack trace (whether generated by `new Error().stack` or
`Error.captureStackTrace(obj)`).
The default value is `10` but may be set to any valid JavaScript number. Changes
will affect any stack trace captured _after_ the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.
#### Inherited from
`Error.stackTraceLimit`
#### Defined in
node\_modules/@types/node/globals.d.ts:162
## Methods
### captureStackTrace()
> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
Creates a `.stack` property on `targetObject`, which when accessed returns
a string representing the location in the code at which
`Error.captureStackTrace()` was called.
```js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
```
The first line of the trace will be prefixed with
`${myObject.name}: ${myObject.message}`.
The optional `constructorOpt` argument accepts a function. If given, all frames
above `constructorOpt`, including `constructorOpt`, will be omitted from the
generated stack trace.
The `constructorOpt` argument is useful for hiding implementation
details of error generation from the user. For instance:
```js
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();
```
#### Parameters
**targetObject**: `object`
**constructorOpt?**: `Function`
#### Returns
`void`
#### Inherited from
`Error.captureStackTrace`
#### Defined in
node\_modules/@types/node/globals.d.ts:146
***
### prepareStackTrace()
> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`
#### Parameters
@@ -134,44 +224,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
#### Defined in
node\_modules/@types/node/globals.d.ts:11
***
### stackTraceLimit
> `static` **stackTraceLimit**: `number`
#### Inherited from
`Error.stackTraceLimit`
#### Defined in
node\_modules/@types/node/globals.d.ts:13
## Methods
### captureStackTrace()
> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
Create .stack property on a target object
#### Parameters
**targetObject**: `object`
**constructorOpt?**: `Function`
#### Returns
`void`
#### Inherited from
`Error.captureStackTrace`
#### Defined in
node\_modules/@types/node/globals.d.ts:4
node\_modules/@types/node/globals.d.ts:150