Interface CorrelationIdMiddlewareOptions

Correlation ID middleware configuration.

interface CorrelationIdMiddlewareOptions {
    generate?: () => string;
    requestHeaders?: string[];
    responseHeader?: string | false;
}

Properties

generate?: () => string

Custom ID generator.

generateCorrelationId

requestHeaders?: string[]

Headers to read from incoming request (checked in order).

['X-Correlation-Id', 'X-Request-Id']

responseHeader?: string | false

Header to set on the response. Set to false to skip setting a response header entirely.

'X-Correlation-Id'