LoaderHeader Enum

Accepted header keys for requests coming to the Loader

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/container-definitions/legacy.

For more information about our API support guarantees, see here.

Signature

export declare enum LoaderHeader

Flags

Flag	Alerts	Description
cache	Deprecated, Alpha
clientDetails	Alpha
loadMode	Alpha	Start the container in a paused, unconnected state. Defaults to false
reconnect	Alpha
sequenceNumber	Alpha	Loads the container to at least the specified sequence number. If not defined, behavior will fall back to IContainerLoadMode.opsBeforeReturn.
version	Alpha	One of the following: null or "null": use ops, no snapshots undefined: fetch latest snapshot otherwise, version sha to load snapshot

cache

This API is deprecated and will be removed in a future release.

This header has been deprecated and will be removed in a future release Override the Loader's default caching behavior for this container.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-definitions/alpha.

For more information about our API support guarantees, see here.

Signature

cache = "fluid-cache"

clientDetails

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-definitions/alpha.

For more information about our API support guarantees, see here.

Signature

clientDetails = "fluid-client-details"

loadMode

Start the container in a paused, unconnected state. Defaults to false

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-definitions/alpha.

For more information about our API support guarantees, see here.

Signature

loadMode = "loadMode"

reconnect

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-definitions/alpha.

For more information about our API support guarantees, see here.

Signature

reconnect = "fluid-reconnect"

sequenceNumber

Loads the container to at least the specified sequence number. If not defined, behavior will fall back to IContainerLoadMode.opsBeforeReturn.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-definitions/alpha.

For more information about our API support guarantees, see here.

Signature

sequenceNumber = "fluid-sequence-number"

version

One of the following: null or "null": use ops, no snapshots undefined: fetch latest snapshot otherwise, version sha to load snapshot

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-definitions/alpha.

For more information about our API support guarantees, see here.

Signature

version = "version"