IOnDemandSummarizeOptions Interface
Packages > @fluidframework/container-runtime > IOnDemandSummarizeOptions
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 IOnDemandSummarizeOptions extends ISummarizeOptions
Extends: ISummarizeOptions
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| reason |
Alpha
|
readonly
|
string | Reason for generating summary. |
| retryOnFailure |
Alpha
|
optional, readonly
|
boolean | In case of a failure, will attempt to retry based on if the failure is retriable. |
Property Details
reason
Reason for generating summary.
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 .
Signature
readonly reason: string;
Type: string
retryOnFailure
In case of a failure, will attempt to retry based on if the failure is retriable.
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 .
Signature
readonly retryOnFailure?: boolean;
Type: boolean