IBatchMessage Interface

Payload type for IContainerContext.submitBatchFn()

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 interface IBatchMessage

Properties

Property	Alerts	Modifiers	Type	Description
compression	Alpha	optional	string
contents	Alpha	optional	string
metadata	Alpha	optional	Record<string, unknown>
referenceSequenceNumber	Alpha	optional	number

Property Details

compression

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

compression?: string;

Type: string

contents

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

contents?: string;

Type: string

metadata

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

metadata?: Record<string, unknown>;

Type: Record<string, unknown>

referenceSequenceNumber

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

referenceSequenceNumber?: number;

Type: number