ServerTimingConfig
Defined in: src/policies/observability/server-timing.ts:25
Configuration for the serverTiming policy.
Extends
Section titled “Extends”Properties
Section titled “Properties”descriptionFn()?
Section titled “descriptionFn()?”
optionaldescriptionFn: (name) =>string
Defined in: src/policies/observability/server-timing.ts:35
Optional function to generate a description for each timing entry.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”string
includeTotal?
Section titled “includeTotal?”
optionalincludeTotal:boolean
Defined in: src/policies/observability/server-timing.ts:33
Add a total entry to Server-Timing. Default: true.
precision?
Section titled “precision?”
optionalprecision:number
Defined in: src/policies/observability/server-timing.ts:31
Number of decimal places for duration values. Default: 1.
responseTimeHeader?
Section titled “responseTimeHeader?”
optionalresponseTimeHeader:boolean
Defined in: src/policies/observability/server-timing.ts:29
Emit the X-Response-Time header with total gateway time. Default: true.
serverTimingHeader?
Section titled “serverTimingHeader?”
optionalserverTimingHeader:boolean
Defined in: src/policies/observability/server-timing.ts:27
Emit the Server-Timing header with per-policy breakdown. Default: true.
skip()?
Section titled “skip()?”
optionalskip: (c) =>boolean|Promise<boolean>
Defined in: src/policies/types.ts:90
Skip this policy when condition returns true
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”boolean | Promise<boolean>
Inherited from
Section titled “Inherited from”visibility?
Section titled “visibility?”
optionalvisibility:ServerTimingVisibility
Defined in: src/policies/observability/server-timing.ts:37
Controls when timing headers are emitted. Default: "debug-only".
visibilityFn()?
Section titled “visibilityFn()?”
optionalvisibilityFn: (c) =>boolean|Promise<boolean>
Defined in: src/policies/observability/server-timing.ts:39
Required when visibility is "conditional". Called per-request to decide.
Parameters
Section titled “Parameters”Context
Returns
Section titled “Returns”boolean | Promise<boolean>