UploadOptions
Defined in: packages/synapse-sdk/src/types.ts:401
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:403
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:390
Called when the service provider has added the piece and submitted the transaction to the chain
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
transaction? | TransactionResponse |
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:392
Called when the service provider agrees that the piece addition is confirmed on-chain
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
pieceIds | number[] |
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”UploadCallbacks.onPieceConfirmed
onUploadComplete()?
Section titled “onUploadComplete()?”optional onUploadComplete: (pieceCid) => void;Defined in: packages/synapse-sdk/src/types.ts:388
Called when upload to service provider completes
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
pieceCid | PieceLink |
Returns
Section titled “Returns”void