API

createEnforcedRequestHandler()

A function that returns a default request handler with built-in HUMAN enforcement. Useful if there is little request/response manipulation in your Edgio Edge Function.

createEnforcedRequestHandler(
    config: HumanSecurityConfiguration,
    onPass: (request: Request) => Response | Promise<Response>,
    onResponse?: (response: Response) => Response | Promise<Response>,
) => ((request: Request, context: Context) => Promise<Response>)

• Parameters
  • config: HumanSecurityConfiguration
  • onPass: (request: Request) => Response | Promise<Response>
  • onResponse?: (response: Response) => Response | Promise<Response>
• Returns a default HTTP request handler function in the form of (request: Request, context: Context) => Promise<Response>

HumanSecurity

constructor

Creates a new instance of the HumanSecurity class from a HumanSecurityConfiguration object (see the configuration section for more information).

constructor(params: HumanSecurityConfiguration) => HumanSecurity

• Parameters
  • params: ConfigurationParams
• Returns a new instance of the HumanSecurity class

createEnforcer()

Creates a new Enforcer instance.

createEnforcer() => Enforcer

• Returns a new Enforcer instance with the configurations provided to the HumanSecurity instance

Enforcer

The entity responsible for performing HUMAN enforcement.

enforce()

Executes the enforcement functionality, returning either a response or null depending on which action should be taken.

enforce(request: Request, context: Context) => Promise<Response | null>

• Parameters
  • request: Request
  • context: Context
• Returns a Promise resolving to a Response or null

postEnforce()

Performs any post-enforcement processing actions and final modifications to (i.e., setting cookies or headers on) the response if needed.

postEnforce(response: Response) => Promise<void>

• Parameters
  • response: Response
• Returns a Promise resolving to void