Class AbstractGetInsightsResponse<T>`Abstract`

Abstract class for representing a response from a Page Insights request.

Author

Tiago Grosso tiagogrosso99@gmail.com

Since

0.1.0

Type Parameters

T extends AbstractMetric<unknown>

Hierarchy

AbstractResponse<T[]>
- AbstractGetInsightsResponse

Index

Constructors

Properties

Methods

getData getMetricByExpression getMetricByName getMetrics getMetricsByExpression getMetricsByRegex

Constructors

constructor

new AbstractGetInsightsResponse<T>(data: T[]): AbstractGetInsightsResponse<T>
The constructor.
Type Parameters
- T extends AbstractMetric<unknown, T>
Parameters
- data: T[]
  
  the response data.
Returns AbstractGetInsightsResponse<T>
Inherited from AbstractResponse.constructor
- Defined in main/requests/AbstractResponse.ts:20

Properties

`Protected` data

data: T[]

The response data.

Methods

getData

getData(): T[]
Gets the response data.

Returns
the response data.

Returns T[]
Inherited from AbstractResponse.getData
- Defined in main/requests/AbstractResponse.ts:29

getMetricByExpression

getMetricByExpression(expression: ((metric: T) => boolean)): undefined | T
Finds the first metric that matches the given expression. Returns undefined if no match is found.

Returns
the first metric that matches the given expression or undefined if no match is found.
Parameters
- expression: ((metric: T) => boolean)
  
  the expression to match with the metric.
  - - (metric: T): boolean
    - Parameters
      
      metric: T
      
      Returns boolean
Returns undefined | T
- Defined in main/requests/AbstractGetInsightsResponse.ts:27

getMetricByName

getMetricByName(name: string, ignoreCase?: boolean): undefined | T
Finds the metric with the given name. Returns undefined if not found.

Returns
the metric with the given name or undefined if not found.
Parameters
- name: string
  
  the name of the metric.
- ignoreCase: boolean = true
  
  whether to ignore the case of the name. True by default.
Returns undefined | T
- Defined in main/requests/AbstractGetInsightsResponse.ts:50

getMetrics

getMetrics(): T[]
Gets the metrics in the response.

Returns
the metrics in the response.

Returns T[]
- Defined in main/requests/AbstractGetInsightsResponse.ts:16

getMetricsByExpression

getMetricsByExpression(expression: ((metric: T) => boolean)): T[]
Finds all the metrics that match the given expression.

Returns
an array of the metrics that match the expression.
Parameters
- expression: ((metric: T) => boolean)
  
  the expression to match with the metrics.
  - - (metric: T): boolean
    - Parameters
      
      metric: T
      
      Returns boolean
Returns T[]
- Defined in main/requests/AbstractGetInsightsResponse.ts:38

getMetricsByRegex

getMetricsByRegex(regexString: string): T[]
Finds all the metrics whose names match the given regex.

Returns
the metrics whose names match the given regex.
Parameters
- regexString: string
Returns T[]
- Defined in main/requests/AbstractGetInsightsResponse.ts:64

Generated using TypeDoc