SalesforceQueryLimitError
Generated API reference for SalesforceQueryLimitError in @kysoql/rest.
@kysoql/rest / SalesforceQueryLimitError
Thrown when configured pagination limits are exceeded before a query completes.
Extends
Error
Constructors
Constructor
new SalesforceQueryLimitError(limit): SalesforceQueryLimitError;Creates an error indicating a configured query safety limit was exceeded.
Parameters
| Parameter | Type |
|---|---|
limit | "maxPages" | "maxRecords" |
Returns
SalesforceQueryLimitError
Overrides
Error.constructorMethods
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.
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:
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
| Parameter | Type |
|---|---|
targetObject | object |
constructorOpt? | Function |
Returns
void
Inherited from
Error.captureStackTraceprepareStackTrace()
static prepareStackTrace(err, stackTraces): any;Parameters
| Parameter | Type |
|---|---|
err | Error |
stackTraces | CallSite[] |
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
Error.prepareStackTrace