Skip to main content

ISnapshotOptions Interface

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

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

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

Signature​

export interface ISnapshotOptions

Properties​

Property Alerts Modifiers Type Description
blobs Alpha optional number
channels Alpha optional number
deltas Alpha optional number
mds Alpha optional number Maximum Data size (in bytes)
timeout Alpha optional number

Property Details​

blobs​

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

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

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

Signature​

blobs?: number;

Type: number

channels​

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

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

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

Signature​

channels?: number;

Type: number

deltas​

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

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

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

Signature​

deltas?: number;

Type: number

mds​

Maximum Data size (in bytes)

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

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

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

Signature​

mds?: number;

Type: number

Remarks​

If specified, SPO will fail snapshot request with 413 error (see @fluidframework/odsp-driver-definitions#(OdspErrorTypes:variable).snapshotTooBig) if snapshot is bigger in size than specified limit.

timeout​

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

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

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

Signature​

timeout?: number;

Type: number