# ProviderError

Defined in: [packages/synapse-core/src/errors/provider.ts:20](https://github.com/FilOzone/synapse-sdk/blob/ef6c62c2d5e01c004a5cdb1a12bfa58ab9ee1834/packages/synapse-core/src/errors/provider.ts#L20)

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

When the provider answered with a non-2xx response, [ProviderError.status](/reference/filoz/synapse-core/errors/classes/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.

## Extends

- [`SynapseError`](/reference/filoz/synapse-core/errors/classes/synapseerror/)

## Extended by

- [`CreateDataSetError`](/reference/filoz/synapse-core/errors/classes/createdataseterror/)
- [`GetDataSetError`](/reference/filoz/synapse-core/errors/classes/getdataseterror/)
- [`PostPieceError`](/reference/filoz/synapse-core/errors/classes/postpieceerror/)
- [`UploadPieceError`](/reference/filoz/synapse-core/errors/classes/uploadpieceerror/)
- [`FindPieceError`](/reference/filoz/synapse-core/errors/classes/findpieceerror/)
- [`AddPiecesError`](/reference/filoz/synapse-core/errors/classes/addpieceserror/)
- [`DeletePieceError`](/reference/filoz/synapse-core/errors/classes/deletepieceerror/)
- [`TerminateServiceError`](/reference/filoz/synapse-core/errors/classes/terminateserviceerror/)
- [`WaitForTerminateServiceError`](/reference/filoz/synapse-core/errors/classes/waitforterminateserviceerror/)
- [`DownloadPieceError`](/reference/filoz/synapse-core/errors/classes/downloadpieceerror/)
- [`PullError`](/reference/filoz/synapse-core/errors/classes/pullerror/)

## Constructors

### Constructor

> **new ProviderError**(`message`, `details`, `options?`): `ProviderError`

Defined in: [packages/synapse-core/src/errors/provider.ts:34](https://github.com/FilOzone/synapse-sdk/blob/ef6c62c2d5e01c004a5cdb1a12bfa58ab9ee1834/packages/synapse-core/src/errors/provider.ts#L34)

#### Parameters

| 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`](/reference/filoz/synapse-core/errors/interfaces/providererroroptions/) | The HTTP status and the underlying error. |

#### Returns

`ProviderError`

#### Overrides

[`SynapseError`](/reference/filoz/synapse-core/errors/classes/synapseerror/).[`constructor`](/reference/filoz/synapse-core/errors/classes/synapseerror/#constructor)

## Properties

### \[symbol\]

> **\[symbol\]**: `boolean` = `true`

Defined in: [packages/synapse-core/src/errors/provider.ts:21](https://github.com/FilOzone/synapse-sdk/blob/ef6c62c2d5e01c004a5cdb1a12bfa58ab9ee1834/packages/synapse-core/src/errors/provider.ts#L21)

#### Inherited from

[`SynapseError`](/reference/filoz/synapse-core/errors/classes/synapseerror/).[`[symbol]`](/reference/filoz/synapse-core/errors/classes/synapseerror/#symbol)

***

### \[symbol\]

> **\[symbol\]**: `boolean` = `true`

Defined in: [packages/synapse-core/src/errors/base.ts:19](https://github.com/FilOzone/synapse-sdk/blob/ef6c62c2d5e01c004a5cdb1a12bfa58ab9ee1834/packages/synapse-core/src/errors/base.ts#L19)

#### Inherited from

`SynapseError.[symbol]`

***

### cause?

> `optional` **cause?**: [`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)

Defined in: [packages/synapse-core/src/errors/base.ts:22](https://github.com/FilOzone/synapse-sdk/blob/ef6c62c2d5e01c004a5cdb1a12bfa58ab9ee1834/packages/synapse-core/src/errors/base.ts#L22)

#### Inherited from

[`SynapseError`](/reference/filoz/synapse-core/errors/classes/synapseerror/).[`cause`](/reference/filoz/synapse-core/errors/classes/synapseerror/#cause)

***

### details?

> `optional` **details?**: `string`

Defined in: [packages/synapse-core/src/errors/base.ts:23](https://github.com/FilOzone/synapse-sdk/blob/ef6c62c2d5e01c004a5cdb1a12bfa58ab9ee1834/packages/synapse-core/src/errors/base.ts#L23)

#### Inherited from

[`SynapseError`](/reference/filoz/synapse-core/errors/classes/synapseerror/).[`details`](/reference/filoz/synapse-core/errors/classes/synapseerror/#details)

***

### message

> **message**: `string`

Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.es5.d.ts:1075

#### Inherited from

[`SynapseError`](/reference/filoz/synapse-core/errors/classes/synapseerror/).[`message`](/reference/filoz/synapse-core/errors/classes/synapseerror/#message)

***

### name

> **name**: `string` = `'ProviderError'`

Defined in: [packages/synapse-core/src/errors/provider.ts:23](https://github.com/FilOzone/synapse-sdk/blob/ef6c62c2d5e01c004a5cdb1a12bfa58ab9ee1834/packages/synapse-core/src/errors/provider.ts#L23)

#### Overrides

[`SynapseError`](/reference/filoz/synapse-core/errors/classes/synapseerror/).[`name`](/reference/filoz/synapse-core/errors/classes/synapseerror/#name)

***

### notFound

> **notFound**: `boolean`

Defined in: [packages/synapse-core/src/errors/provider.ts:27](https://github.com/FilOzone/synapse-sdk/blob/ef6c62c2d5e01c004a5cdb1a12bfa58ab9ee1834/packages/synapse-core/src/errors/provider.ts#L27)

`true` when the service provider answered 404.

***

### shortMessage

> **shortMessage**: `string`

Defined in: [packages/synapse-core/src/errors/base.ts:24](https://github.com/FilOzone/synapse-sdk/blob/ef6c62c2d5e01c004a5cdb1a12bfa58ab9ee1834/packages/synapse-core/src/errors/base.ts#L24)

#### Inherited from

[`SynapseError`](/reference/filoz/synapse-core/errors/classes/synapseerror/).[`shortMessage`](/reference/filoz/synapse-core/errors/classes/synapseerror/#shortmessage)

***

### stack?

> `optional` **stack?**: `string`

Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.es5.d.ts:1076

#### Inherited from

[`SynapseError`](/reference/filoz/synapse-core/errors/classes/synapseerror/).[`stack`](/reference/filoz/synapse-core/errors/classes/synapseerror/#stack)

***

### status?

> `optional` **status?**: `number`

Defined in: [packages/synapse-core/src/errors/provider.ts:25](https://github.com/FilOzone/synapse-sdk/blob/ef6c62c2d5e01c004a5cdb1a12bfa58ab9ee1834/packages/synapse-core/src/errors/provider.ts#L25)

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

***

### stackTraceLimit

> `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.

#### Inherited from

[`SynapseError`](/reference/filoz/synapse-core/errors/classes/synapseerror/).[`stackTraceLimit`](/reference/filoz/synapse-core/errors/classes/synapseerror/#stacktracelimit)

## Methods

### toJSON()

> **toJSON**(): [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `unknown`\>

Defined in: [packages/synapse-core/src/errors/provider.ts:43](https://github.com/FilOzone/synapse-sdk/blob/ef6c62c2d5e01c004a5cdb1a12bfa58ab9ee1834/packages/synapse-core/src/errors/provider.ts#L43)

#### Returns

[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `unknown`\>

#### Overrides

[`SynapseError`](/reference/filoz/synapse-core/errors/classes/synapseerror/).[`toJSON`](/reference/filoz/synapse-core/errors/classes/synapseerror/#tojson)

***

### captureStackTrace()

> `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.

```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

| Parameter | Type |
| ------ | ------ |
| `targetObject` | `object` |
| `constructorOpt?` | [`Function`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function) |

#### Returns

`void`

#### Inherited from

[`SynapseError`](/reference/filoz/synapse-core/errors/classes/synapseerror/).[`captureStackTrace`](/reference/filoz/synapse-core/errors/classes/synapseerror/#capturestacktrace)

***

### fromHttpError()

> `static` **fromHttpError**\<`T`\>(`this`, `error`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`T`\>

Defined in: [packages/synapse-core/src/errors/provider.ts:60](https://github.com/FilOzone/synapse-sdk/blob/ef6c62c2d5e01c004a5cdb1a12bfa58ab9ee1834/packages/synapse-core/src/errors/provider.ts#L60)

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 Parameters

| Type Parameter |
| ------ |
| <a id="type-parameter-t"></a> `T` |

#### Parameters

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

#### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`T`\>

#### Example

```ts
throw await PullError.fromHttpError(response.error)
```

***

### is()

> `static` **is**(`value`): `value is ProviderError`

Defined in: [packages/synapse-core/src/errors/provider.ts:73](https://github.com/FilOzone/synapse-sdk/blob/ef6c62c2d5e01c004a5cdb1a12bfa58ab9ee1834/packages/synapse-core/src/errors/provider.ts#L73)

Check if a value is a [ProviderError](/reference/filoz/synapse-core/errors/classes/providererror/) or one of its subclasses.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `value` | `unknown` |

#### Returns

`value is ProviderError`

#### Overrides

[`SynapseError`](/reference/filoz/synapse-core/errors/classes/synapseerror/).[`is`](/reference/filoz/synapse-core/errors/classes/synapseerror/#is)

***

### isError()

> `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.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `error` | `unknown` |

#### Returns

`error is Error`

#### Inherited from

[`SynapseError`](/reference/filoz/synapse-core/errors/classes/synapseerror/).[`isError`](/reference/filoz/synapse-core/errors/classes/synapseerror/#iserror)

***

### prepareStackTrace()

> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`

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

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `err` | [`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error) |
| `stackTraces` | `CallSite`[] |

#### Returns

`any`

#### See

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

#### Inherited from

[`SynapseError`](/reference/filoz/synapse-core/errors/classes/synapseerror/).[`prepareStackTrace`](/reference/filoz/synapse-core/errors/classes/synapseerror/#preparestacktrace)