CORE CONCEPTS

Modules

A module groups related controllers, providers, and middleware under an optional URL prefix. defineModule() is a typed pass-through helper. It returns the same object you pass in, just with type-checking.

user.module.ts
import { defineModule } from '@rasenganjs/server';
import { UserController } from './user.controller';
import { UserService } from './user.service';
 
export default defineModule({
  prefix: '/users',
  controllers: [UserController],
  providers: [UserService],
});

ModuleConfig

interface ModuleConfig {
  name?: string; // diagnostic only, used in DI error messages
  prefix?: string; // URL prefix for this module's routes
  middlewares?: Middleware[]; // module-level middleware
  imports?: ModuleConfig[]; // sub-modules to flatten in
  controllers?: (new (...args: any[]) => Controller)[]; // controllers to register
  providers?: (ProviderLike | ProviderDefinition)[]; // DI providers, private by default
  exports?: any[]; // providers[] tokens visible to importers
  global?: boolean; // make exports visible to EVERY module
  [extensionKey: string]: unknown; // open extension point (see Module Plugins)
}

Composing Modules with imports

A root module typically imports every feature module. The whole tree is flattened at compile time, depth-first, with each module appearing once even if imported from multiple places:

app.module.ts
import { defineModule } from '@rasenganjs/server';
import userModule from './user.module';
import chatRoomModule from './chat-room.module';
 
export default defineModule({
  imports: [userModule, chatRoomModule],
});
main.ts
bootstrap((app) => {
  app.registerModule(appModule); // only the root module is registered directly
});

Provider Visibility: exports and global

Providers declared in providers are private to their own module by default. Another module can't inject them just by importing. Two ways to share:

Exporting a provider to importers
export default defineModule({
  providers: [DatabaseService],
  exports: [DatabaseService], // now visible to any module that imports this one
});
Making a provider globally visible
export default defineModule({
  providers: [ConfigService],
  exports: [ConfigService],
  global: true, // visible to EVERY module, no import needed
});

A module's visible set (what its controllers/providers can resolve) is exactly: its own providers, its imports' exported tokens, and every global: true module's exported tokens.

Module-level Middleware

Scoping middleware to a module
export default defineModule({
  prefix: '/admin',
  middlewares: [requireAdmin],
  controllers: [AdminController],
});

requireAdmin runs for every route under /admin, before any controller- or route-level middleware.

Route Prefix Composition

prefix is applied on top of each controller's own route paths. A controller registering router.get("/:id", ...) inside a module with prefix: "/users" responds at GET /users/:id.

Bootstrap & ServerApp
Controllers & Routing