UploadOptions
Defined in: packages/synapse-sdk/src/types.ts:431
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
Section titled “Extends”Properties
Section titled “Properties”metadata?
Section titled “metadata?”optional metadata: Record<string, string>;Defined in: packages/synapse-sdk/src/types.ts:433
Custom metadata for this specific piece (key-value pairs)
onPieceAdded()?
Section titled “onPieceAdded()?”optional onPieceAdded: (transaction?) => void;Defined in: packages/synapse-sdk/src/types.ts:407
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
transaction? | `0x${string}` |
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”onPieceConfirmed()?
Section titled “onPieceConfirmed()?”optional onPieceConfirmed: (pieceIds) => void;Defined in: packages/synapse-sdk/src/types.ts:411
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
pieceIds | number[] |
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”UploadCallbacks.onPieceConfirmed
onPiecesAdded()?
Section titled “onPiecesAdded()?”optional onPiecesAdded: (transaction?, pieces?) => void;Defined in: packages/synapse-sdk/src/types.ts:405
Called when the service provider has added the piece(s) and submitted the transaction to the chain
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
transaction? | `0x${string}` |
pieces? | object[] |
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”onPiecesConfirmed()?
Section titled “onPiecesConfirmed()?”optional onPiecesConfirmed: (dataSetId, pieces) => void;Defined in: packages/synapse-sdk/src/types.ts:409
Called when the service provider agrees that the piece addition(s) are confirmed on-chain
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
dataSetId | number |
pieces | PieceRecord[] |
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”UploadCallbacks.onPiecesConfirmed
onProgress()?
Section titled “onProgress()?”optional onProgress: (bytesUploaded) => void;Defined in: packages/synapse-sdk/src/types.ts:401
Called periodically during upload with bytes uploaded so far
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
bytesUploaded | number |
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”onUploadComplete()?
Section titled “onUploadComplete()?”optional onUploadComplete: (pieceCid) => void;Defined in: packages/synapse-sdk/src/types.ts:403
Called when upload to service provider completes
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
pieceCid | PieceLink |
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”UploadCallbacks.onUploadComplete
pieceCid?
Section titled “pieceCid?”optional pieceCid: PieceLink;Defined in: packages/synapse-sdk/src/types.ts:435
Optional pre-calculated PieceCID to skip CommP calculation (BYO PieceCID)
signal?
Section titled “signal?”optional signal: AbortSignal;Defined in: packages/synapse-sdk/src/types.ts:437
Optional AbortSignal to cancel the upload