Skip to main content

InboundAttachMessage TypeAlias

This type should be used when reading an incoming attach op, but it should not be used when creating a new attach op. Older versions of attach messages could have null snapshots, so this gives correct typings for writing backward compatible code. \

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 InboundAttachMessage = Omit<IAttachMessage, "snapshot"> & {
snapshot: IAttachMessage["snapshot"] | null;
};