IContainerRuntimeBaseEvents Interface

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.

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 IContainerRuntimeBaseEvents extends IEvent

Extends: IEvent

Call Signatures

CallSignature	Alerts	Description
(event: "batchBegin", listener: (op: Omit<ISequencedDocumentMessage, "contents">) => void): any	Alpha	Indicates the beginning of an incoming batch of ops
(event: "batchEnd", listener: (error: unknown, op: Omit<ISequencedDocumentMessage, "contents">) => void): any	Alpha	Indicates the end of an incoming batch of ops
(event: "op", listener: (op: ISequencedDocumentMessage, runtimeMessage?: boolean) => void): any	Alpha	Indicates that an incoming op has been processed.
(event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void): any	Alpha
(event: "dispose", listener: () => void): any	Alpha

Call Signature Details

(event: "batchBegin", listener: (op: Omit<ISequencedDocumentMessage, "contents">) => void): any

Indicates the beginning of an incoming batch of ops

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

(event: "batchBegin", listener: (op: Omit<ISequencedDocumentMessage, "contents">) => void): any;

(event: "batchEnd", listener: (error: unknown, op: Omit<ISequencedDocumentMessage, "contents">) => void): any

Indicates the end of an incoming batch of ops

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

(event: "batchEnd", listener: (error: unknown, op: Omit<ISequencedDocumentMessage, "contents">) => void): any;

(event: "op", listener: (op: ISequencedDocumentMessage, runtimeMessage?: boolean) => void): any

Indicates that an incoming op has been processed.

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

(event: "op", listener: (op: ISequencedDocumentMessage, runtimeMessage?: boolean) => void): any;

(event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void): any

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

(event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void): any;

(event: "dispose", listener: () => void): any

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

(event: "dispose", listener: () => void): any;