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

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

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 .

compression?: string;

Type: string

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 .

contents?: string;

Type: string

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 .

metadata?: Record<string, unknown>;

Type: Record<string, unknown>

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 .

referenceSequenceNumber?: number;

Type: number