StorageContextCreateOptions
Defined in: packages/synapse-sdk/src/types.ts:440
Options for creating or selecting a single storage context via createContext()
Extends BaseContextOptions with singular provider/dataset selection.
Extends
Section titled “Extends”Properties
Section titled “Properties”callbacks?
Section titled “callbacks?”
optionalcallbacks?:StorageContextCallbacks
Defined in: packages/synapse-sdk/src/types.ts:372
Callbacks for creation process
Inherited from
Section titled “Inherited from”StorageServiceOptions.callbacks
cdnGroup?
Section titled “cdnGroup?”
optionalcdnGroup?:string
Defined in: packages/synapse-sdk/src/types.ts:363
CDN group id used as the withCDN metadata value when CDN is enabled. Every context (primary
and secondaries) that shares this value resolves to the same shared CDN bandwidth rail in FWSS
(keyed by keccak256(payer, cdnGroup)), so a multi-copy CDN upload buys bandwidth once instead
of once per copy. Opt-in and empty by default, which keeps a dedicated bandwidth rail per data
set and preserves exact-metadata reuse.
Inherited from
Section titled “Inherited from”StorageServiceOptions.cdnGroup
dataSetId?
Section titled “dataSetId?”
optionaldataSetId?:bigint
Defined in: packages/synapse-sdk/src/types.ts:437
Specific data set ID to use (optional)
Inherited from
Section titled “Inherited from”StorageServiceOptions.dataSetId
excludeProviderIds?
Section titled “excludeProviderIds?”
optionalexcludeProviderIds?:bigint[]
Defined in: packages/synapse-sdk/src/types.ts:435
Do not select any of these providers
Inherited from
Section titled “Inherited from”StorageServiceOptions.excludeProviderIds
metadata?
Section titled “metadata?”
optionalmetadata?:Record<string,string>
Defined in: packages/synapse-sdk/src/types.ts:369
Custom metadata for data sets (key-value pairs). Used to match existing data sets during provider selection.
Inherited from
Section titled “Inherited from”StorageServiceOptions.metadata
providerId?
Section titled “providerId?”
optionalproviderId?:bigint
Defined in: packages/synapse-sdk/src/types.ts:433
Specific provider ID to use (optional)
Inherited from
Section titled “Inherited from”StorageServiceOptions.providerId
synapse
Section titled “synapse”synapse:
Synapse
Defined in: packages/synapse-sdk/src/types.ts:442
The Synapse instance
warmStorageService
Section titled “warmStorageService”warmStorageService:
WarmStorageService
Defined in: packages/synapse-sdk/src/types.ts:444
The WarmStorageService instance
withCDN?
Section titled “withCDN?”
optionalwithCDN?:boolean
Defined in: packages/synapse-sdk/src/types.ts:354
Whether to enable CDN services