StorageManagerUploadOptions
Defined in: packages/synapse-sdk/src/storage/manager.ts:72
Internal
Upload options for StorageManager.upload() - the all-in-one upload method
This is the “uber-shortcut” method that can handle everything from context creation to piece upload in a single call. It combines:
- Storage context creation options (provider selection, data set creation)
- Upload callbacks (both creation and upload progress)
- Piece-specific metadata
Usage patterns:
- With explicit context:
{ context, callbacks?, metadata? }- routes to context.upload() - Auto-create context:
{ providerId?, dataSetId?, withCDN?, callbacks?, metadata? }- creates/reuses context - Use default context:
{ callbacks?, metadata? }- uses cached default context
This type is intentionally not exported as it’s specific to StorageManager
Extends
Section titled “Extends”Properties
Section titled “Properties”callbacks?
Section titled “callbacks?”optional callbacks: Partial<CombinedCallbacks>;Defined in: packages/synapse-sdk/src/storage/manager.ts:77
Callbacks for creation process
Overrides
Section titled “Overrides”StorageServiceOptions.callbacks
context?
Section titled “context?”optional context: StorageContext;Defined in: packages/synapse-sdk/src/storage/manager.ts:74
dataSetId?
Section titled “dataSetId?”optional dataSetId: number;Defined in: packages/synapse-sdk/src/types.ts:337
Specific data set ID to use (optional)
Inherited from
Section titled “Inherited from”StorageServiceOptions.dataSetId
optional dev: boolean;Defined in: packages/synapse-sdk/src/types.ts:341
Inherited from
Section titled “Inherited from”forceCreateDataSet?
Section titled “forceCreateDataSet?”optional forceCreateDataSet: boolean;Defined in: packages/synapse-sdk/src/types.ts:343
Force creation of a new data set, even if a candidate exists
Inherited from
Section titled “Inherited from”StorageServiceOptions.forceCreateDataSet
metadata?
Section titled “metadata?”optional metadata: Record<string, string>;Defined in: packages/synapse-sdk/src/types.ts:349
Custom metadata for the data set (key-value pairs)
Inherited from
Section titled “Inherited from”StorageServiceOptions.metadata
providerAddress?
Section titled “providerAddress?”optional providerAddress: string;Defined in: packages/synapse-sdk/src/types.ts:335
Specific provider address to use (optional)
Inherited from
Section titled “Inherited from”StorageServiceOptions.providerAddress
providerId?
Section titled “providerId?”optional providerId: number;Defined in: packages/synapse-sdk/src/types.ts:333
Specific provider ID to use (optional)
Inherited from
Section titled “Inherited from”StorageServiceOptions.providerId
uploadBatchSize?
Section titled “uploadBatchSize?”optional uploadBatchSize: number;Defined in: packages/synapse-sdk/src/types.ts:345
Maximum number of uploads to process in a single batch (default: 32, minimum: 1)
Inherited from
Section titled “Inherited from”StorageServiceOptions.uploadBatchSize
withCDN?
Section titled “withCDN?”optional withCDN: boolean;Defined in: packages/synapse-sdk/src/types.ts:339
Whether to enable CDN services
Inherited from
Section titled “Inherited from”withIpni?
Section titled “withIpni?”optional withIpni: boolean;Defined in: packages/synapse-sdk/src/types.ts:340