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:

1. With explicit context: { context, callbacks?, metadata? } - routes to context.upload()
2. Auto-create context: { providerId?, dataSetId?, withCDN?, callbacks?, metadata? } - creates/reuses context
3. Use default context: { callbacks?, metadata? } - uses cached default context

This type is intentionally not exported as it’s specific to StorageManager

Properties

callbacks?

optional callbacks: Partial<CombinedCallbacks>;

Defined in: packages/synapse-sdk/src/storage/manager.ts:92

---

context?

optional context: StorageContext;

Defined in: packages/synapse-sdk/src/storage/manager.ts:74

---

dataSetId?

optional dataSetId: number;

Defined in: packages/synapse-sdk/src/storage/manager.ts:83

Specific data set ID to use

---

forceCreateDataSet?

optional forceCreateDataSet: boolean;

Defined in: packages/synapse-sdk/src/storage/manager.ts:87

Force creation of a new data set

---

metadata?

optional metadata: Record<string, string>;

Defined in: packages/synapse-sdk/src/storage/manager.ts:95

---

providerAddress?

optional providerAddress: string;

Defined in: packages/synapse-sdk/src/storage/manager.ts:81

Specific provider address to use

---

providerId?

optional providerId: number;

Defined in: packages/synapse-sdk/src/storage/manager.ts:79

Specific provider ID to use

---

uploadBatchSize?

optional uploadBatchSize: number;

Defined in: packages/synapse-sdk/src/storage/manager.ts:89

Maximum uploads per batch (default: 32)

---

withCDN?

optional withCDN: boolean;

Defined in: packages/synapse-sdk/src/storage/manager.ts:85

Whether to enable CDN services