Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InternalStringMetricType

Base implementation of the string metric type, meant only for Glean internal use.

This class exposes Glean-internal properties and methods of the string metric type.

Hierarchy

Index

Constructors

Properties

Methods

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(): Promise<string>

  • The metric's unique identifier, including the category, name and label.

    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(value: string): void

setUndispatched

  • setUndispatched(value: string): Promise<void>

  • An implemention of set that does not dispatch the recording task.

    Important

    This method should never be exposed to users.

    Parameters

    • value: string

      The string we want to set to.

    Returns Promise<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>

testGetValue

  • testGetValue(ping?: string): Promise<undefined | string>

Generated using TypeDoc