GuardSurface
Defined in: packages/fastify/src/plugin.ts:22
Properties
Section titled “Properties”agentStats
Section titled “agentStats”
readonlyagentStats:object&Record<string,unknown>
Defined in: packages/fastify/src/plugin.ts:31
Type Declaration
Section titled “Type Declaration”degraded
Section titled “degraded”degraded:
boolean
enabled
Section titled “enabled”enabled:
boolean
Methods
Section titled “Methods”addStatusRoute()
Section titled “addStatusRoute()”addStatusRoute(
path?):void
Defined in: packages/fastify/src/plugin.ts:33
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
createErrorResponse()
Section titled “createErrorResponse()”createErrorResponse(
statusCode,message):Promise<GuardResponse>
Defined in: packages/fastify/src/plugin.ts:32
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/fastify/src/plugin.ts:25
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/fastify/src/plugin.ts:24
Returns
Section titled “Returns”void
refreshCloudIpRanges()
Section titled “refreshCloudIpRanges()”refreshCloudIpRanges():
Promise<void>
Defined in: packages/fastify/src/plugin.ts:30
Returns
Section titled “Returns”Promise<void>
reset()
Section titled “reset()”reset():
Promise<void>
Defined in: packages/fastify/src/plugin.ts:23
Returns
Section titled “Returns”Promise<void>