Skip to main content

IDeltaSender Interface

Contract supporting delivery of outbound messages to the server

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.

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature​

/** @sealed */
export interface IDeltaSender

Methods​

Method Alerts Return Type Description
flush() Alpha void Flush all pending messages through the outbound queue

Method Details​

flush​

Flush all pending messages through the outbound queue

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

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

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature​
flush(): void;