API reference

These tables describe @velajs/vela@1.22.1 and @velajs/cloudflare@1.22.1. The documentation site reads their installed npm declarations at build time. Hover over the identifiers in the examples to inspect their types.

Module options

Pass these options to @Module() to register controllers, providers, and imports.

import { Controller, Get, Injectable, Module } from '@velajs/vela';

@Injectable()
class GreetingService {
  getMessage(): string {
    return 'Hello from Vela!';
  }
}

@Controller('/')
class GreetingController {
  constructor(private readonly greeting: GreetingService) {}

  @Get()
  getHello() {
    return { message: this.greeting.getMessage() };
  }
}

@Module({
  controllers: [GreetingController],
  providers: [GreetingService],
})
class AppModule {}

The generated Workers starter uses SWC to emit the constructor metadata needed for this injection. See the quick start.

Dynamic modules

Return a DynamicModule from a configuration method such as forRoot().

Worker options

Options for createCloudflareWorker() with an environment containing no application bindings. For a Worker with bindings, replace Record<string, never> with your own environment interface in the InjectionToken type argument.

import { createCloudflareWorker } from '@velajs/cloudflare';
import { InjectionToken, Module } from '@velajs/vela';

@Module({})
class AppModule {}

const ENV = new InjectionToken<Record<string, never>>('Worker environment');

export default createCloudflareWorker(AppModule, { envToken: ENV });

The Worker initializes the application per native environment. The environment is registered before provider factories and lifecycle hooks run.

Reference coverage

This Fumadocs reference focuses on module options, dynamic modules, and Worker options, with checked examples and type hovers. It does not cover every class, decorator, method, overload, or package entrypoint. The framework no longer produces a standalone automatic API reference.

For APIs beyond these tables, consult the core package guide, Cloudflare integration guide, and framework guides. The published packages include TypeScript declarations for editor completion and signature inspection. OpenAPI and typed HTTP client generation remain available for your application's endpoints; see the HTTP client guide.