Class RequestTiming

constructor

• new RequestTiming(): RequestTiming

  Returns RequestTiming

log

StaticdefaultLogger

counter

• counter(): number

  Returns number

endTime

• endTime(section: undefined | symbol | DisposableTimingHandle): void

  Parameters

  • section: undefined | symbol | DisposableTimingHandle

  Returns void

• endTime(section: undefined | string, deduplicate?: boolean): void

  Parameters

  • section: undefined | string
  • Optionaldeduplicate: boolean

  Returns void

  Deprecated

  Use endTime(section: symbol) instead

getAllTiming

• getAllTiming(): { [section: string]: { duration: number; name: string } }

  Returns { [section: string]: { duration: number; name: string } }

runTimer

• runTimer<T, TName extends string>(
      section: TimingSectionName<TName>,
      code: () => Promise<T>,
  ): Promise<T>

  Type Parameters

  • T
  • TName extends string

  Parameters

  • section: TimingSectionName<TName>
  • code: () => Promise<T>

  Returns Promise<T>

startTime

• startTime<TName extends string>(
      section: TimingSectionName<TName>,
  ): DisposableTimingHandle

  Start timing a section of code

  Type Parameters

  • TName extends string

  Parameters

  • section: TimingSectionName<TName>

    Name of the section to time -- should be unique within the code base so that it can be identified later

  Returns DisposableTimingHandle

  A handle which can be used to end the timing section

toServerTimingHeader

• toServerTimingHeader(): string

  Builds a Server-Timing header value from finished sections. Returns an empty string when no finished section remains.

  Returns string

StaticrunTimer

• runTimer<T, TName extends string>(
      section: TimingSectionName<TName>,
      timing: undefined | RequestTiming,
      code: () => Promise<T>,
  ): Promise<T>

  Run a piece of code and time it, returning the result of the code

  This takes an optional "timing" parameter which is a timing object if one exists, to update -- if this parameter is undefined no timing will be done.

  Type Parameters

  • T
  • TName extends string

  Parameters

  • section: TimingSectionName<TName>

    Name of the section to time -- should be unique within the code base so that it can be identified later
  • timing: undefined | RequestTiming

    Timing object to update, if available
  • code: () => Promise<T>

    The code to run

  Returns Promise<T>

  The result of the code