SalesforceOAuthError

@kysoql/rest / SalesforceOAuthError

Thrown when a Salesforce OAuth token request fails.

ExtendsCopy Anchor Link

• Error

ConstructorsCopy Anchor Link

ConstructorCopy Anchor Link

new SalesforceOAuthError(status, code?): SalesforceOAuthError;

Creates an OAuth error from a Salesforce HTTP status and OAuth error code.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

SalesforceOAuthError

OverridesCopy Anchor Link

Error.constructor

MethodsCopy Anchor Link

captureStackTrace()Copy Anchor Link

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();

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

void

Inherited fromCopy Anchor Link

Error.captureStackTrace

prepareStackTrace()Copy Anchor Link

static prepareStackTrace(err, stackTraces): any;

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

any

SeeCopy Anchor Link

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited fromCopy Anchor Link

Error.prepareStackTrace

PropertiesCopy Anchor Link