Skip to content

ProviderError

Defined in: packages/synapse-core/src/errors/provider.ts:20

Base class for errors raised when a service provider request fails.

When the provider answered with a non-2xx response, ProviderError.status holds the HTTP status and cause the HttpError, so callers can tell a client problem (4xx) from one worth retrying (429, 5xx) without parsing the message.

new ProviderError(message, details, options?): ProviderError

Defined in: packages/synapse-core/src/errors/provider.ts:34

Parameter Type Description
message string The short message, such as Failed to pull pieces from storage provider.
details string | undefined What went wrong, such as the decoded response body.
options? ProviderErrorOptions The HTTP status and the underlying error.

ProviderError

SynapseError.constructor

[symbol]: boolean = true

Defined in: packages/synapse-core/src/errors/provider.ts:21

SynapseError.[symbol]


[symbol]: boolean = true

Defined in: packages/synapse-core/src/errors/base.ts:19

SynapseError.[symbol]


optional cause?: Error

Defined in: packages/synapse-core/src/errors/base.ts:22

SynapseError.cause


optional details?: string

Defined in: packages/synapse-core/src/errors/base.ts:23

SynapseError.details


message: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075

SynapseError.message


name: string = 'ProviderError'

Defined in: packages/synapse-core/src/errors/provider.ts:23

SynapseError.name


notFound: boolean

Defined in: packages/synapse-core/src/errors/provider.ts:27

true when the service provider answered 404.


shortMessage: string

Defined in: packages/synapse-core/src/errors/base.ts:24

SynapseError.shortMessage


optional stack?: string

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

SynapseError.stack


optional status?: number

Defined in: packages/synapse-core/src/errors/provider.ts:25

The HTTP status the service provider answered with. undefined when the failure was not an HTTP response.


static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@26.2.0/node_modules/@types/node/globals.d.ts:67

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.

SynapseError.stackTraceLimit

toJSON(): Record<string, unknown>

Defined in: packages/synapse-core/src/errors/provider.ts:43

Record<string, unknown>

SynapseError.toJSON


static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@26.2.0/node_modules/@types/node/globals.d.ts:51

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();
Parameter Type
targetObject object
constructorOpt? Function

void

SynapseError.captureStackTrace


static fromHttpError<T>(this, error): Promise<T>

Defined in: packages/synapse-core/src/errors/provider.ts:60

Build the error from an HttpError, keeping the response status and the HttpError as cause. The response body becomes details, or HTTP <status> when the body is empty.

Type Parameter
T
Parameter Type
this new (error, options) => T
error HttpError

Promise<T>

throw await PullError.fromHttpError(response.error)

static is(value): value is ProviderError

Defined in: packages/synapse-core/src/errors/provider.ts:73

Check if a value is a ProviderError or one of its subclasses.

Parameter Type
value unknown

value is ProviderError

SynapseError.is


static isError(error): error is Error

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.esnext.error.d.ts:21

Indicates whether the argument provided is a built-in Error instance or not.

Parameter Type
error unknown

error is Error

SynapseError.isError


static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@26.2.0/node_modules/@types/node/globals.d.ts:55

Parameter Type
err Error
stackTraces CallSite[]

any

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

SynapseError.prepareStackTrace