@fluidframework/shared-summary-block Package

Packages > @fluidframework/shared-summary-block

Interfaces

Interface Alerts Description
ISharedSummaryBlock Legacy, Alpha Shared summary block interface. A shared summary block is part of the summary but it does not generate any ops. The set on this interface must only be called in response to a remote op. Basically, if we replay same ops, the set of calls on this interface to set data should be the same. This is critical because the object does not generate ops of its own, but relies on the above principle to maintain eventual consistency and to summarize.

Types

TypeAlias Alerts Description
SharedSummaryBlock Legacy, Alpha Shared summary block interface. A shared summary block is part of the summary but it does not generate any ops. The set on this interface must only be called in response to a remote op. Basically, if we replay same ops, the set of calls on this interface to set data should be the same. This is critical because the object does not generate ops of its own, but relies on the above principle to maintain eventual consistency and to summarize.

Variables

Variable Alerts Modifiers Type Description
SharedSummaryBlock Legacy, Alpha readonly import("@fluidframework/shared-object-base/internal").ISharedObjectKind<ISharedSummaryBlock> & import("@fluidframework/shared-object-base/internal").SharedObjectKind<ISharedSummaryBlock> Shared summary block interface. A shared summary block is part of the summary but it does not generate any ops. The set on this interface must only be called in response to a remote op. Basically, if we replay same ops, the set of calls on this interface to set data should be the same. This is critical because the object does not generate ops of its own, but relies on the above principle to maintain eventual consistency and to summarize.

Variable Details

SharedSummaryBlock

Shared summary block interface. A shared summary block is part of the summary but it does not generate any ops. The set on this interface must only be called in response to a remote op. Basically, if we replay same ops, the set of calls on this interface to set data should be the same. This is critical because the object does not generate ops of its own, but relies on the above principle to maintain eventual consistency and to summarize.

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

To use, import via @fluidframework/shared-summary-block/legacy.

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

Signature

SharedSummaryBlock: import("@fluidframework/shared-object-base/internal").ISharedObjectKind<ISharedSummaryBlock> & import("@fluidframework/shared-object-base/internal").SharedObjectKind<ISharedSummaryBlock>

Type: import("@fluidframework/shared-object-base/internal").ISharedObjectKind <ISharedSummaryBlock > & import("@fluidframework/shared-object-base/internal").SharedObjectKind <ISharedSummaryBlock >