UploadOptions

Defined in: packages/synapse-sdk/src/types.ts:424

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

Properties

metadata?

optional metadata: Record<string, string>;

Defined in: packages/synapse-sdk/src/types.ts:426

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

---

onPieceAdded()?

optional onPieceAdded: (transaction?) => void;

Defined in: packages/synapse-sdk/src/types.ts:413

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

Parameters

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

Returns

void

Inherited from

UploadCallbacks.onPieceAdded

---

onPieceConfirmed()?

optional onPieceConfirmed: (pieceIds) => void;

Defined in: packages/synapse-sdk/src/types.ts:415

Called when the service provider agrees that the piece addition is confirmed on-chain

Parameters

Parameter	Type
pieceIds	number[]

Returns

void

Inherited from

UploadCallbacks.onPieceConfirmed

---

onProgress()?

optional onProgress: (bytesUploaded) => void;

Defined in: packages/synapse-sdk/src/types.ts:409

Called periodically during upload with bytes uploaded so far

Parameters

Parameter	Type
bytesUploaded	number

Returns

void

Inherited from

UploadCallbacks.onProgress

---

onUploadComplete()?

optional onUploadComplete: (pieceCid) => void;

Defined in: packages/synapse-sdk/src/types.ts:411

Called when upload to service provider completes

Parameters

Parameter	Type
pieceCid	PieceLink

Returns

void

Inherited from

UploadCallbacks.onUploadComplete

---

pieceCid?

optional pieceCid: PieceLink;

Defined in: packages/synapse-sdk/src/types.ts:428

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

---

signal?

optional signal: AbortSignal;

Defined in: packages/synapse-sdk/src/types.ts:430

Optional AbortSignal to cancel the upload