GuardMiddlewareSurface
Defined in: packages/express/src/middleware.ts:23
Properties
Section titled “Properties”agentStats
Section titled “agentStats”agentStats:
object&Record<string,unknown>
Defined in: packages/express/src/middleware.ts:37
The reference agent_stats.
Type Declaration
Section titled “Type Declaration”degraded
Section titled “degraded”degraded:
boolean
enabled
Section titled “enabled”enabled:
boolean
Methods
Section titled “Methods”createErrorResponse()
Section titled “createErrorResponse()”createErrorResponse(
statusCode,message):Promise<GuardResponse>
Defined in: packages/express/src/middleware.ts:39
The reference create_error_response.
Parameters
Section titled “Parameters”statusCode
Section titled “statusCode”number
message
Section titled “message”string
Returns
Section titled “Returns”Promise<GuardResponse>
getInitializationStatus()
Section titled “getInitializationStatus()”getInitializationStatus():
object
Defined in: packages/express/src/middleware.ts:29
The reference get_initialization_status.
Returns
Section titled “Returns”object
agent:
object
agent.degraded
Section titled “agent.degraded”degraded:
boolean
agent.enabled
Section titled “agent.enabled”enabled:
boolean
initialized
Section titled “initialized”initialized:
boolean
redis:
boolean
markInitialized()
Section titled “markInitialized()”markInitialized():
void
Defined in: packages/express/src/middleware.ts:27
The reference mark_initialized.
Returns
Section titled “Returns”void
refreshCloudIpRanges()
Section titled “refreshCloudIpRanges()”refreshCloudIpRanges():
Promise<void>
Defined in: packages/express/src/middleware.ts:35
The reference refresh_cloud_ip_ranges.
Returns
Section titled “Returns”Promise<void>
reset()
Section titled “reset()”reset():
Promise<void>
Defined in: packages/express/src/middleware.ts:25
The reference reset(): clear the rate-limit tier state.
Returns
Section titled “Returns”Promise<void>