Options
All
  • Public
  • Public/Protected
  • All
Menu

A URL metric.

Hierarchy

Index

Constructors

constructor

Properties

Readonly category

category: string

Readonly disabled

disabled: boolean

Optional dynamicLabel

dynamicLabel: string

Readonly lifetime

lifetime: Lifetime

Readonly name

name: string

Readonly sendInPings

sendInPings: string[]

Readonly type

type: string

Methods

baseIdentifier

  • baseIdentifier(): string
  • The metric's base identifier, including the category and name, but not the label.

    Returns string

    The generated identifier. If category is empty, it's ommitted. Otherwise, it's the combination of the metric's category and name.

identifier

  • identifier(metricsDatabase: default): Promise<string>
  • The metric's unique identifier, including the category, name and label.

    Parameters

    • metricsDatabase: default

      The metrics database.

    Returns Promise<string>

    The generated identifier. If category is empty, it's ommitted. Otherwise, it's the combination of the metric's category, name and label.

set

  • set(url: string): void

setUrl

  • setUrl(url: URL): void

shouldRecord

  • shouldRecord(uploadEnabled: boolean): boolean
  • Verify whether or not this metric instance should be recorded.

    Parameters

    • uploadEnabled: boolean

      Whether or not global upload is enabled or disabled.

    Returns boolean

    Whether or not this metric instance should be recorded.

testGetNumRecordedErrors

  • testGetNumRecordedErrors(errorType: string, ping?: string): Promise<number>
  • Returns the number of errors recorded for the given metric.

    Parameters

    • errorType: string

      The type of the error recorded.

    • ping: string = ...

      represents the name of the ping to retrieve the metric for. Defaults to the first value in sendInPings.

    Returns Promise<number>

    the number of errors recorded for the metric.

testGetValue

  • testGetValue(ping?: string): Promise<undefined | string>
  • Test-only API.**

    Gets the currently stored value as a string.

    Note

    Although URL metrics are URI encoded in the ping payload, this function will return the unencoded URL for convenience.

    This doesn't clear the stored value.

    TODO: Only allow this function to be called on test mode (depends on Bug 1682771).

    Parameters

    • ping: string = ...

      the ping from which we want to retrieve this metrics value from. Defaults to the first value in sendInPings.

    Returns Promise<undefined | string>

    The value found in storage or undefined if nothing was found.

Legend

  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Type alias with type parameter
  • Class
  • Class with type parameter
  • Constructor
  • Method
  • Inherited property
  • Inherited method
  • Enumeration
  • Interface

Generated using TypeDoc