IFluidDataStoreAttributes0 Interface

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

This interface will no longer be exported in the future(AB#8004).

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

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

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

Signature

export interface IFluidDataStoreAttributes0

Properties

Property	Alerts	Modifiers	Type	Description
isRootDataStore	Beta	optional, readonly	boolean	This tells whether a data store is root. Root data stores are never collected. Non-root data stores may be collected if they are not used. If this is not present, default it to true. This will ensure that older data stores are incorrectly collected.
pkg	Beta		string
snapshotFormatVersion	Beta	optional, readonly	undefined
summaryFormatVersion	Beta	optional, readonly	undefined

Property Details

isRootDataStore

This tells whether a data store is root. Root data stores are never collected. Non-root data stores may be collected if they are not used. If this is not present, default it to true. This will ensure that older data stores are incorrectly collected.

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

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

Signature

readonly isRootDataStore?: boolean;

Type: boolean

pkg

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

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

Signature

pkg: string;

Type: string

snapshotFormatVersion

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

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

Signature

readonly snapshotFormatVersion?: undefined;

Type: undefined

summaryFormatVersion

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

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

Signature

readonly summaryFormatVersion?: undefined;

Type: undefined