Skip to main content

ISequencedMessageEnvelope TypeAlias

This is the message type that is used within the runtime when processing a sequenced message. It is the same as ISequencedDocumentMessage, but without the contents and clientSequenceNumbers which are sent separately. The contents are modified at multiple layers in the stack so having it separate doesn't require packing and unpacking the entire message.

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

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

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

Signature

export type ISequencedMessageEnvelope = Omit<ISequencedDocumentMessage, "contents" | "clientSequenceNumber">;