Skip to content

ContextCreateContextsOptions

Defined in: packages/synapse-sdk/src/types.ts:281

Options for creating multiple storage contexts via createContexts()

Extends BaseContextOptions with plural provider/dataset selection and count for multi-provider redundancy.

optional callbacks: StorageContextCallbacks

Defined in: packages/synapse-sdk/src/types.ts:257

Callbacks for creation process

CreateContextsOptions.callbacks


optional count: number

Defined in: packages/synapse-sdk/src/types.ts:268

Number of contexts to create (optional, defaults to 2)

CreateContextsOptions.count


optional dataSetIds: bigint[]

Defined in: packages/synapse-sdk/src/types.ts:272

Specific data set IDs to use (mutually exclusive with providerIds)

CreateContextsOptions.dataSetIds


optional excludeProviderIds: bigint[]

Defined in: packages/synapse-sdk/src/types.ts:278

Do not select any of these providers

CreateContextsOptions.excludeProviderIds


optional metadata: Record<string, string>

Defined in: packages/synapse-sdk/src/types.ts:254

Custom metadata for data sets (key-value pairs). Used to match existing data sets during provider selection.

CreateContextsOptions.metadata


optional providerIds: bigint[]

Defined in: packages/synapse-sdk/src/types.ts:276

Specific provider IDs to use (mutually exclusive with dataSetIds)

CreateContextsOptions.providerIds


synapse: Synapse

Defined in: packages/synapse-sdk/src/types.ts:283

The Synapse instance


warmStorageService: WarmStorageService

Defined in: packages/synapse-sdk/src/types.ts:285

The WarmStorageService instance


optional withCDN: boolean

Defined in: packages/synapse-sdk/src/types.ts:248

Whether to enable CDN services

CreateContextsOptions.withCDN