Skip to content

Entrypoints

The entrypoints module provides the root interfaces and instantiation hooks for the TypeScript Gateway. It acts as the primary boundary for embedding the gateway programmatically within Node.js applications or spinning it up via command-line execution. Requests enter the gateway lifecycle through the server and router instances initialized here.

SymbolKindSignaturePurpose
Gatewayclassclass GatewayClass export for Gateway.
{ OpenApiDoc, OpenApiInfo }typetype { OpenApiDoc, OpenApiInfo } from './core/openapi-generator.js'Type export for { OpenApiDoc, OpenApiInfo }.

The Gateway class orchestrates server setup, configuration ingestion, and pipeline assembly.

Exported OpenAPI types define contract structures when generating documentation from routes.

  • src/index.ts
  • src/cli.ts