Edit

Share via

IPerformanceClient interface

Package:
@azure/msal-browser

Methods

addFields({[key: string]: {} | undefined}, string)
addPerformanceCallback(PerformanceCallbackFunction)
addQueueMeasurement(string, string, number, boolean)
calculateQueuedTime(number, number)
discardMeasurements(string)
emitEvents(PerformanceEvent[], string)
endMeasurement(PerformanceEvent)
generateId()
incrementFields({[key: string]: number | undefined}, string)
removePerformanceCallback(string)
setPreQueueTime(string, string)
startMeasurement(string, string)
startPerformanceMeasurement(string, string)

Method Details

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

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

Parameters

fields

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

correlationId

string

addPerformanceCallback(PerformanceCallbackFunction) 

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parameters

callback
PerformanceCallbackFunction

Returns

string

addQueueMeasurement(string, string, number, boolean) 

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

Parameters

eventName

string

correlationId

string

queueTime

number

manuallyCompleted

boolean

calculateQueuedTime(number, number) 

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

Parameters

preQueueTime

number

currentTime

number

Returns

number

discardMeasurements(string) 

function discardMeasurements(correlationId: string)

Parameters

correlationId

string

emitEvents(PerformanceEvent[], string) 

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

Parameters

events

PerformanceEvent[]

correlationId

string

endMeasurement(PerformanceEvent) 

function endMeasurement(event: PerformanceEvent): null | PerformanceEvent

Parameters

event
PerformanceEvent

Returns

null | PerformanceEvent

generateId() 

function generateId(): string

Returns

string

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

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

Parameters

fields

{[key: string]: number | undefined}

correlationId

string

removePerformanceCallback(string) 

function removePerformanceCallback(callbackId: string): boolean

Parameters

callbackId

string

Returns

boolean

setPreQueueTime(string, string) 

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

Parameters

eventName

string

correlationId

string

startMeasurement(string, string) 

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

Parameters

measureName

string

correlationId

string

Returns

InProgressPerformanceEvent

startPerformanceMeasurement(string, string)

Warning

This API is now deprecated.

This method will be removed in the next major version

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

Parameters

measureName

string

correlationId

string

Returns

@azure/msal-common.IPerformanceMeasurement