planning-center-monorepo v1.0.0

planning-center-monorepo / planning-center-people-ts/src / PcoError

Class: PcoError

Defined in: packages/planning-center-base-ts/dist/errors/error-handling.d.ts:28

Extends

• PcoApiError

Constructors

Constructor

new PcoError(message, status, statusText, errors, rateLimitHeaders?, context?): PcoError

Defined in: packages/planning-center-base-ts/dist/errors/error-handling.d.ts:33

Parameters

message

string

status

number

statusText

string

errors

ErrorObject[]

rateLimitHeaders?

Record<string, string | undefined>

context?

Partial<ErrorContext>

Returns

PcoError

Overrides

PcoApiError.constructor

Properties

status

readonly status: number

Defined in: packages/planning-center-base-ts/dist/errors/api-error.d.ts:4

Inherited from

PcoApiError.status

statusText

readonly statusText: string

Defined in: packages/planning-center-base-ts/dist/errors/api-error.d.ts:5

Inherited from

PcoApiError.statusText

errors

readonly errors: ErrorObject[]

Defined in: packages/planning-center-base-ts/dist/errors/api-error.d.ts:6

Inherited from

PcoApiError.errors

rateLimitHeaders?

readonly optional rateLimitHeaders: RateLimitHeaders

Defined in: packages/planning-center-base-ts/dist/errors/api-error.d.ts:7

Inherited from

PcoApiError.rateLimitHeaders

category

readonly category: ErrorCategory

Defined in: packages/planning-center-base-ts/dist/errors/error-handling.d.ts:29

severity

readonly severity: ErrorSeverity

Defined in: packages/planning-center-base-ts/dist/errors/error-handling.d.ts:30

context

readonly context: ErrorContext

Defined in: packages/planning-center-base-ts/dist/errors/error-handling.d.ts:31

retryable

readonly retryable: boolean

Defined in: packages/planning-center-base-ts/dist/errors/error-handling.d.ts:32

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:68

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

PcoApiError.stackTraceLimit

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

PcoApiError.name

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

PcoApiError.message

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

PcoApiError.stack

Methods

fromFetchError()

static fromFetchError(response, data?, context?): PcoError

Defined in: packages/planning-center-base-ts/dist/errors/error-handling.d.ts:35

Parameters

response

Response

data?

any

context?

Partial<ErrorContext>

Returns

PcoError

Overrides

PcoApiError.fromFetchError

fromNetworkError()

static fromNetworkError(error, context?): PcoError

Defined in: packages/planning-center-base-ts/dist/errors/error-handling.d.ts:36

Parameters

error

Error

context?

Partial<ErrorContext>

Returns

PcoError

fromTimeoutError()

static fromTimeoutError(timeoutMs, context?): PcoError

Defined in: packages/planning-center-base-ts/dist/errors/error-handling.d.ts:37

Parameters

timeoutMs

number

context?

Partial<ErrorContext>

Returns

PcoError

getRetryDelay()

getRetryDelay(): number

Defined in: packages/planning-center-base-ts/dist/errors/error-handling.d.ts:38

Returns

number

shouldRetry()

shouldRetry(): boolean

Defined in: packages/planning-center-base-ts/dist/errors/error-handling.d.ts:39

Returns

boolean

getErrorSummary()

getErrorSummary(): Record<string, any>

Defined in: packages/planning-center-base-ts/dist/errors/error-handling.d.ts:40

Returns

Record<string, any>

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:52

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

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

PcoApiError.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:56

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

PcoApiError.prepareStackTrace