IExecutionResultLimitBreak
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Describes a limit broken during result computation, resulting in partial data being returned.
export interface IExecutionResultLimitBreak<TLimitType extends string = ExecutionResultLimitType | (string & {})>
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| number | (ALPHA) The configured limit value. | |
| TLimitType | (ALPHA) Type of the limit that was broken. | |
| number | (ALPHA) (Optional) The actual value that triggered the limit. It is omitted when the value cannot be determined exactly. |
Property details
IExecutionResultLimitBreak.limitpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
The configured limit value.
readonly limit: number;
IExecutionResultLimitBreak.limitTypepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Type of the limit that was broken.
readonly limitType: TLimitType;
IExecutionResultLimitBreak.valuepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
The actual value that triggered the limit. It is omitted when the value cannot be determined exactly.
readonly value?: number;