Class default

An object representing a SpeedCurve performance budget

Hierarchy

default

Index

Constructors

Properties

absoluteThreshold budgetId chart crossings largestCrossing metricName metricSuffix relativeThreshold status

Methods

appendMetricSuffix getLatestYValue fromApiResponse

Constructors

constructor

new default(budgetId: number, status: string, metricName: string, absoluteThreshold: number, relativeThreshold: number, metricSuffix: string): default
Parameters
- budgetId: number
- status: string
- metricName: string
- absoluteThreshold: number
- relativeThreshold: number
- metricSuffix: string
Returns default
- Defined in model/performance-budget.ts:19

Properties

absoluteThreshold

absoluteThreshold: number

budgetId

budgetId: number

chart

chart: ChartApiResponse

crossings

crossings: BudgetCrossingApiResponse[]

largestCrossing

largestCrossing: BudgetCrossingApiResponse

metricName

metricName: string

metricSuffix

metricSuffix: string

relativeThreshold

relativeThreshold: number

status

status: string

Methods

appendMetricSuffix

appendMetricSuffix(value: number): string
Append the budget metric suffix to a value
Parameters
- value: number
Returns string
- Defined in model/performance-budget.ts:46

getLatestYValue

getLatestYValue(crossing: BudgetCrossingApiResponse): number
Get the most recent Y value from a crossing
Parameters
- crossing: BudgetCrossingApiResponse
Returns number
- Defined in model/performance-budget.ts:39

`Static` fromApiResponse

fromApiResponse(response: BudgetApiResponse): default
Build a new Budget object from a https://api.speedcurve.com/#get-performance-budgets|/v1/budgets API response object
Parameters
- response: BudgetApiResponse
Returns default
- Defined in model/performance-budget.ts:54

Generated using TypeDoc