# UploadOptions

Defined in: [packages/synapse-sdk/src/types.ts:416](https://github.com/FilOzone/synapse-sdk/blob/32f86959b0bf15557657ea412e31a0897440ca98/packages/synapse-sdk/src/types.ts#L416)

Options for uploading individual pieces to an existing storage context

Used by StorageContext.upload() for uploading data to a specific provider
and data set that has already been created/selected.

## Extends

- [`UploadCallbacks`](/reference/filoz/synapse-sdk/synapse/interfaces/uploadcallbacks/)

## Properties

### metadata?

> `optional` **metadata**: [`MetadataObject`](/reference/filoz/synapse-sdk/synapse/type-aliases/metadataobject/)

Defined in: [packages/synapse-sdk/src/types.ts:418](https://github.com/FilOzone/synapse-sdk/blob/32f86959b0bf15557657ea412e31a0897440ca98/packages/synapse-sdk/src/types.ts#L418)

Custom metadata for this specific piece (key-value pairs)

***

### ~~onPieceAdded()?~~

> `optional` **onPieceAdded**: (`transaction?`) => `void`

Defined in: [packages/synapse-sdk/src/types.ts:392](https://github.com/FilOzone/synapse-sdk/blob/32f86959b0bf15557657ea412e31a0897440ca98/packages/synapse-sdk/src/types.ts#L392)

:::caution[Deprecated]
  Use onPiecesAdded instead
  :::

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `transaction?` | `` `0x${string}` `` |

#### Returns

`void`

#### Inherited from

[`UploadCallbacks`](/reference/filoz/synapse-sdk/synapse/interfaces/uploadcallbacks/).[`onPieceAdded`](/reference/filoz/synapse-sdk/synapse/interfaces/uploadcallbacks/#onpieceadded)

***

### ~~onPieceConfirmed()?~~

> `optional` **onPieceConfirmed**: (`pieceIds`) => `void`

Defined in: [packages/synapse-sdk/src/types.ts:396](https://github.com/FilOzone/synapse-sdk/blob/32f86959b0bf15557657ea412e31a0897440ca98/packages/synapse-sdk/src/types.ts#L396)

:::caution[Deprecated]
  Use onPiecesConfirmed instead
  :::

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `pieceIds` | `bigint`[] |

#### Returns

`void`

#### Inherited from

[`UploadCallbacks`](/reference/filoz/synapse-sdk/synapse/interfaces/uploadcallbacks/).[`onPieceConfirmed`](/reference/filoz/synapse-sdk/synapse/interfaces/uploadcallbacks/#onpiececonfirmed)

***

### onPiecesAdded()?

> `optional` **onPiecesAdded**: (`transaction?`, `pieces?`) => `void`

Defined in: [packages/synapse-sdk/src/types.ts:390](https://github.com/FilOzone/synapse-sdk/blob/32f86959b0bf15557657ea412e31a0897440ca98/packages/synapse-sdk/src/types.ts#L390)

Called when the service provider has added the piece(s) and submitted the transaction to the chain

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `transaction?` | `` `0x${string}` `` |
| `pieces?` | `object`[] |

#### Returns

`void`

#### Inherited from

[`UploadCallbacks`](/reference/filoz/synapse-sdk/synapse/interfaces/uploadcallbacks/).[`onPiecesAdded`](/reference/filoz/synapse-sdk/synapse/interfaces/uploadcallbacks/#onpiecesadded)

***

### onPiecesConfirmed()?

> `optional` **onPiecesConfirmed**: (`dataSetId`, `pieces`) => `void`

Defined in: [packages/synapse-sdk/src/types.ts:394](https://github.com/FilOzone/synapse-sdk/blob/32f86959b0bf15557657ea412e31a0897440ca98/packages/synapse-sdk/src/types.ts#L394)

Called when the service provider agrees that the piece addition(s) are confirmed on-chain

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `dataSetId` | `bigint` |
| `pieces` | [`PieceRecord`](/reference/filoz/synapse-sdk/synapse/interfaces/piecerecord/)[] |

#### Returns

`void`

#### Inherited from

[`UploadCallbacks`](/reference/filoz/synapse-sdk/synapse/interfaces/uploadcallbacks/).[`onPiecesConfirmed`](/reference/filoz/synapse-sdk/synapse/interfaces/uploadcallbacks/#onpiecesconfirmed)

***

### onProgress()?

> `optional` **onProgress**: (`bytesUploaded`) => `void`

Defined in: [packages/synapse-sdk/src/types.ts:386](https://github.com/FilOzone/synapse-sdk/blob/32f86959b0bf15557657ea412e31a0897440ca98/packages/synapse-sdk/src/types.ts#L386)

Called periodically during upload with bytes uploaded so far

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `bytesUploaded` | `number` |

#### Returns

`void`

#### Inherited from

[`UploadCallbacks`](/reference/filoz/synapse-sdk/synapse/interfaces/uploadcallbacks/).[`onProgress`](/reference/filoz/synapse-sdk/synapse/interfaces/uploadcallbacks/#onprogress)

***

### onUploadComplete()?

> `optional` **onUploadComplete**: (`pieceCid`) => `void`

Defined in: [packages/synapse-sdk/src/types.ts:388](https://github.com/FilOzone/synapse-sdk/blob/32f86959b0bf15557657ea412e31a0897440ca98/packages/synapse-sdk/src/types.ts#L388)

Called when upload to service provider completes

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `pieceCid` | `PieceLink` |

#### Returns

`void`

#### Inherited from

[`UploadCallbacks`](/reference/filoz/synapse-sdk/synapse/interfaces/uploadcallbacks/).[`onUploadComplete`](/reference/filoz/synapse-sdk/synapse/interfaces/uploadcallbacks/#onuploadcomplete)

***

### pieceCid?

> `optional` **pieceCid**: `PieceLink`

Defined in: [packages/synapse-sdk/src/types.ts:420](https://github.com/FilOzone/synapse-sdk/blob/32f86959b0bf15557657ea412e31a0897440ca98/packages/synapse-sdk/src/types.ts#L420)

Optional pre-calculated PieceCID to skip CommP calculation (BYO PieceCID)

***

### signal?

> `optional` **signal**: [`AbortSignal`](https://developer.mozilla.org/docs/Web/API/AbortSignal)

Defined in: [packages/synapse-sdk/src/types.ts:422](https://github.com/FilOzone/synapse-sdk/blob/32f86959b0bf15557657ea412e31a0897440ca98/packages/synapse-sdk/src/types.ts#L422)

Optional AbortSignal to cancel the upload