Skip to main content
Version: v1

IContainerLoadOptions Interface

Signature

export interface IContainerLoadOptions

Properties

PropertyModifiersTypeDescription
canReconnectoptionalbooleanDisables the Container from reconnecting if false, allows reconnect otherwise.
clientDetailsOverrideoptionalIClientDetailsClient details provided in the override will be merged over the default client.
loadModeoptionalIContainerLoadModeLoads the Container in paused state if true, unpaused otherwise.
resolvedUrlIFluidResolvedUrl
versionstring | undefinedControl which snapshot version to load from. See IParsedUrl for detailed information.

Property Details

canReconnect

Disables the Container from reconnecting if false, allows reconnect otherwise.

Signature

canReconnect?: boolean;

Type: boolean

clientDetailsOverride

Client details provided in the override will be merged over the default client.

Signature

clientDetailsOverride?: IClientDetails;

Type: IClientDetails

loadMode

Loads the Container in paused state if true, unpaused otherwise.

Signature

loadMode?: IContainerLoadMode;

Type: IContainerLoadMode

resolvedUrl

Signature

resolvedUrl: IFluidResolvedUrl;

Type: IFluidResolvedUrl

version

Control which snapshot version to load from. See IParsedUrl for detailed information.

Signature

version: string | undefined;

Type: string | undefined