UploadCallbacks
Defined in: packages/synapse-sdk/src/types.ts:398
Extended by
Section titled “Extended by”Properties
Section titled “Properties”onPieceAdded()?
Section titled “onPieceAdded()?”optional onPieceAdded: (transaction?) => void;Defined in: packages/synapse-sdk/src/types.ts:406
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
transaction? | `0x${string}` |
Returns
Section titled “Returns”void
onPieceConfirmed()?
Section titled “onPieceConfirmed()?”optional onPieceConfirmed: (pieceIds) => void;Defined in: packages/synapse-sdk/src/types.ts:410
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
pieceIds | number[] |
Returns
Section titled “Returns”void
onPiecesAdded()?
Section titled “onPiecesAdded()?”optional onPiecesAdded: (transaction?, pieces?) => void;Defined in: packages/synapse-sdk/src/types.ts:404
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
onPiecesConfirmed()?
Section titled “onPiecesConfirmed()?”optional onPiecesConfirmed: (dataSetId, pieces) => void;Defined in: packages/synapse-sdk/src/types.ts:408
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
onProgress()?
Section titled “onProgress()?”optional onProgress: (bytesUploaded) => void;Defined in: packages/synapse-sdk/src/types.ts:400
Called periodically during upload with bytes uploaded so far
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
bytesUploaded | number |
Returns
Section titled “Returns”void
onUploadComplete()?
Section titled “onUploadComplete()?”optional onUploadComplete: (pieceCid) => void;Defined in: packages/synapse-sdk/src/types.ts:402
Called when upload to service provider completes
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
pieceCid | PieceLink |
Returns
Section titled “Returns”void