Modules

Organize your application into cohesive, composable blocks.

Modules group related controllers and providers into cohesive units. Every MiiaJS application has at least one root module.

Defining a module

import { Module } from '@miiajs/core'

@Module({
  controllers: [UserController],
  providers: [UserService],
})
class UserModule {}

Module options

Option	Type	Description
`controllers`	`Constructor[]`	Controllers to register
`providers`	`ProviderDefinition[]`	Services and other providers
`imports`	`(Constructor \| ConfiguredModule)[]`	Other modules to import
`prefix`	`string`	Path prefix for all controllers

Composing modules

Import modules to compose your application:

@Module({
  controllers: [UserController],
  providers: [UserService],
})
class UserModule {}

@Module({
  controllers: [PostController],
  providers: [PostService],
})
class PostModule {}

@Module({
  imports: [UserModule, PostModule],
  controllers: [HealthController],
  prefix: '/api',
})
class AppModule {}

The prefix option prepends a path to all routes in the module and its imported modules:

/api
  /users    (from UserModule)
  /posts    (from PostModule)
  /health   (from AppModule)

Dynamic modules

Some modules need runtime configuration. Use the ConfiguredModule pattern:

class DatabaseModule {
  static configure(url: string): ConfiguredModule {
    return {
      module: DatabaseModule,
      providers: [
        {
          token: 'DB_URL',
          factory: () => url,
        },
        DatabaseService,
      ],
    }
  }
}

Use it in imports:

@Module({
  imports: [
    DatabaseModule.configure(process.env.DATABASE_URL),
  ],
})
class AppModule {}

Many MiiaJS packages use this pattern — ConfigModule.configure() (from @miiajs/config), DrizzleModule.configure(), JwtModule.configure(), PaprModule.configure().

Registering with the app

const app = new Miia()
  .register(AppModule)

await app.listen(3000)

You can register multiple modules:

const app = new Miia()
  .register(AppModule, FeatureModule)

Module loading order

Registration — ModuleLoader processes all modules recursively, registering providers in the DI container
Route resolution — Controllers are instantiated and routes are compiled into the router

Providers

Injectable services, repositories, and the dependency injection system.

Middleware

Transform requests and responses using the Koa-style onion model.