IBaseSummarizeResult Interface

Base results for all submitSummary attempts.

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

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

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

Signature

export interface IBaseSummarizeResult

Property	Alerts	Modifiers	Type	Description
error	`Alpha`	`readonly`	IRetriableFailureError \| undefined	Retriable error object related to failed summarize attempt.
minimumSequenceNumber	`Alpha`	`readonly`	number
referenceSequenceNumber	`Alpha`	`readonly`	number	Reference sequence number as of the generate summary attempt.
stage	`Alpha`	`readonly`	"base"

Retriable error object related to failed summarize attempt.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-runtime/alpha.

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

readonly error: IRetriableFailureError | undefined;

Type: IRetriableFailureError | undefined

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-runtime/alpha.

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

readonly minimumSequenceNumber: number;

Type: number

Reference sequence number as of the generate summary attempt.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-runtime/alpha.

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

readonly referenceSequenceNumber: number;

Type: number

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-runtime/alpha.

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

readonly stage: "base";

Type: “base”