Skip to content

API Overview

X511 exposes two public functions and a set of TypeScript types.

Functions

FunctionDescription
x511(config)Factory function - creates a verification gateway instance
toHono(handler)Wraps the verified function in a Hono middleware
toElysia(handler)Wraps the verified function in an Elysia plugin

Types

TypeDescription
X511ConfigConfiguration object for x511()
VerificationStateUnion type returned by verified()
ProvidersPayloadPer-provider data embedded in the 511 page

Import

ts
import { x511, toHono, toElysia } from 'x511-tba'
import type { X511Config, VerificationState, ProvidersPayload } from 'x511-tba'