StorageServiceOptions
Defined in: packages/synapse-sdk/src/types.ts:343
Options for creating or selecting a storage context
Used by StorageManager.createContext() and indirectly by StorageManager.upload() when auto-creating contexts. Allows specification of:
- Provider selection (by ID or address)
- Data set selection or creation
- CDN enablement and metadata
- Creation process callbacks
Properties
Section titled “Properties”callbacks?
Section titled “callbacks?”optional callbacks: StorageContextCallbacks;Defined in: packages/synapse-sdk/src/types.ts:362
Callbacks for creation process
dataSetId?
Section titled “dataSetId?”optional dataSetId: number;Defined in: packages/synapse-sdk/src/types.ts:351
Specific data set ID to use (optional)
optional dev: boolean;Defined in: packages/synapse-sdk/src/types.ts:356
Whether to include providers with serviceStatus=dev in the capabilities list (default: false)
excludeProviderIds?
Section titled “excludeProviderIds?”optional excludeProviderIds: number[];Defined in: packages/synapse-sdk/src/types.ts:347
Do not select any of these providers
forceCreateDataSet?
Section titled “forceCreateDataSet?”optional forceCreateDataSet: boolean;Defined in: packages/synapse-sdk/src/types.ts:358
Force creation of a new data set, even if a candidate exists
metadata?
Section titled “metadata?”optional metadata: Record<string, string>;Defined in: packages/synapse-sdk/src/types.ts:364
Custom metadata for the data set (key-value pairs)
providerAddress?
Section titled “providerAddress?”optional providerAddress: string;Defined in: packages/synapse-sdk/src/types.ts:349
Specific provider address to use (optional)
providerId?
Section titled “providerId?”optional providerId: number;Defined in: packages/synapse-sdk/src/types.ts:345
Specific provider ID to use (optional)
uploadBatchSize?
Section titled “uploadBatchSize?”optional uploadBatchSize: number;Defined in: packages/synapse-sdk/src/types.ts:360
Maximum number of uploads to process in a single batch (default: 32, minimum: 1)
withCDN?
Section titled “withCDN?”optional withCDN: boolean;Defined in: packages/synapse-sdk/src/types.ts:353
Whether to enable CDN services
withIpni?
Section titled “withIpni?”optional withIpni: boolean;Defined in: packages/synapse-sdk/src/types.ts:354