BrowserPerformanceClient class

Balíček:

@azure/msal-browser

Extends

PerformanceClient

Konstruktory

BrowserPerformanceClient(Configuration, Set<string>, Map<string, string>)

Metody

addQueueMeasurement(string, string, number, boolean)	Vypočítá a přidá měření času fronty pro danou událost výkonu.
generateId()
setPreQueueTime(PerformanceEvents, string)	Přidá čas před frontou do mapy preQueueTimeByCorrelationId.
startMeasurement(string, string)	Spustí měření výkonu dané operace. Vrátí funkci, která by měla být použita k ukončení měření. Zachytává také stav viditelnosti stránky prohlížeče.

Zděděné metody

addFields({[key: string]: {} | undefined}, string)	Uloží další informace, které se mají vygenerovat při vyprázdnění měření.
addPerformanceCallback(PerformanceCallbackFunction)	Zaregistruje funkci zpětného volání pro příjem událostí výkonu.
calculateQueuedTime(number, number)	Vypočítá rozdíl mezi aktuálním časem a časem, kdy byla funkce zařazena do fronty. Poznámka: Jako čas fronty je možné mít 0, pokud aktuální čas a čas zařazený do fronty byl stejný.
discardMeasurements(string)	Odebere měření a pomocné údaje pro dané ID korelace.
emitEvents(PerformanceEvent[], string)	Generuje události do všech registrovaných zpětných volání.
endMeasurement(PerformanceEvent, unknown, AccountInfo)	Zastaví měření výkonu operace. Funkce vrácená funkcí startMeasurement by měla být volána pouze přímo třídami PerformanceClient, protože příjemci by měli místo toho použít funkci vrácenou funkcí startMeasurement. Přidá nové pole s názvem [název události]DurationMs pro dílčí měření, dokončí a vygeneruje událost jinak.
getPreQueueTime(string, string)	Získá mapování časů před frontou podle ID korelace
incrementFields({[key: string]: number | undefined}, string)	Čítače inkrementace, které se mají vyprázdnit při vyprázdnění měření
removePerformanceCallback(string)	Odebere zpětné volání registrované pomocí addPerformanceCallback.
startPerformanceMeasurement(string, string)	Spustí a vrátí implementaci IPerformanceMeasurement specifickou pro platformu. Poznámka: Tuto funkci je možné změnit na abstrakci při dalším nárazu hlavní verze.

Podrobnosti konstruktoru

BrowserPerformanceClient(Configuration, Set<string>, Map<string, string>)

new BrowserPerformanceClient(configuration: Configuration, intFields?: Set<string>, abbreviations?: Map<string, string>)

Parametry

configuration

Configuration

intFields

Set<string>

abbreviations

Map<string, string>

Podrobnosti metody

addQueueMeasurement(string, string, number, boolean)

Vypočítá a přidá měření času fronty pro danou událost výkonu.

function addQueueMeasurement(eventName: string, correlationId?: string, queueTime?: number, manuallyCompleted?: boolean)

Parametry

eventName

string

correlationId

string

queueTime

number

manuallyCompleted

boolean

indikátor pro ručně dokončené měření fronty

generateId()

function generateId(): string

Návraty

string

setPreQueueTime(PerformanceEvents, string)

Přidá čas před frontou do mapy preQueueTimeByCorrelationId.

function setPreQueueTime(eventName: PerformanceEvents, correlationId?: string)

Parametry

eventName

PerformanceEvents

correlationId

string

startMeasurement(string, string)

Spustí měření výkonu dané operace. Vrátí funkci, která by měla být použita k ukončení měření. Zachytává také stav viditelnosti stránky prohlížeče.

function startMeasurement(measureName: string, correlationId?: string): InProgressPerformanceEvent

Parametry

measureName

string

correlationId

string

Návraty

InProgressPerformanceEvent

Podrobnosti zděděných metod

addFields({[key: string]: {} | undefined}, string)

Uloží další informace, které se mají vygenerovat při vyprázdnění měření.

function addFields(fields: {[key: string]: {} | undefined}, correlationId: string)

Parametry

fields

{[key: string]: {} | undefined}

correlationId

string

Zděděno z PerformanceClient.addFields

addPerformanceCallback(PerformanceCallbackFunction)

Zaregistruje funkci zpětného volání pro příjem událostí výkonu.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parametry

callback

PerformanceCallbackFunction

Návraty

string

Zděděno z PerformanceClient.addPerformanceCallback

calculateQueuedTime(number, number)

Vypočítá rozdíl mezi aktuálním časem a časem, kdy byla funkce zařazena do fronty. Poznámka: Jako čas fronty je možné mít 0, pokud aktuální čas a čas zařazený do fronty byl stejný.

function calculateQueuedTime(preQueueTime: number, currentTime: number): number

Parametry

preQueueTime

number

currentTime

number

Návraty

number

Zděděno z PerformanceClient.calculateQueuedTime

discardMeasurements(string)

Odebere měření a pomocné údaje pro dané ID korelace.

function discardMeasurements(correlationId: string)

Parametry

correlationId

string

Zděděno z PerformanceClient.discardMeasurements

emitEvents(PerformanceEvent[], string)

Generuje události do všech registrovaných zpětných volání.

function emitEvents(events: PerformanceEvent[], correlationId?: string)

Parametry

events

PerformanceEvent[]

correlationId

string

Zděděno z PerformanceClient.emitEvents

endMeasurement(PerformanceEvent, unknown, AccountInfo)

Zastaví měření výkonu operace. Funkce vrácená funkcí startMeasurement by měla být volána pouze přímo třídami PerformanceClient, protože příjemci by měli místo toho použít funkci vrácenou funkcí startMeasurement. Přidá nové pole s názvem [název události]DurationMs pro dílčí měření, dokončí a vygeneruje událost jinak.

function endMeasurement(event: PerformanceEvent, error?: unknown, account?: AccountInfo): null | PerformanceEvent

Parametry

event

PerformanceEvent

error

unknown

account

AccountInfo

Návraty

null | PerformanceEvent

Zděděno z PerformanceClient.endMeasurement

getPreQueueTime(string, string)

Získá mapování časů před frontou podle ID korelace

function getPreQueueTime(eventName: string, correlationId: string): number | void

Parametry

eventName

string

correlationId

string

Návraty

number | void

Zděděno z PerformanceClient.getPreQueueTime

incrementFields({[key: string]: number | undefined}, string)

Čítače inkrementace, které se mají vyprázdnit při vyprázdnění měření

function incrementFields(fields: {[key: string]: number | undefined}, correlationId: string)

Parametry

fields

{[key: string]: number | undefined}

{string[]}

correlationId

string

Identifikátor korelace {string}

Zděděno z PerformanceClient.incrementFields

removePerformanceCallback(string)

Odebere zpětné volání registrované pomocí addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Parametry

callbackId

string

Návraty

boolean

Zděděno z PerformanceClient.removePerformanceCallback

startPerformanceMeasurement(string, string)

Upozornění

Toto rozhraní API je teď zastaralé.

This method will be removed in the next major version

Spustí a vrátí implementaci IPerformanceMeasurement specifickou pro platformu. Poznámka: Tuto funkci je možné změnit na abstrakci při dalším nárazu hlavní verze.

function startPerformanceMeasurement(measureName: string, correlationId: string): IPerformanceMeasurement

Parametry

measureName

string

correlationId

string

Návraty

IPerformanceMeasurement

Zděděno z PerformanceClient.startPerformanceMeasurement