Documentation
    Preparing search index...

    Type Alias RoutesScannerRules

    Configuration rules accepted by the routes scanner to customize the scanning behavior and override type inference.

    const rules: RoutesScannerRules = {
      skip: ['admin.dashboard', 'health.check'],
      response: {
        'users.index': {
          type: 'PaginatedResponse<User[]>',
          imports: ['import { User } from "#models/user"']
        }
      },
      request: {
        'users.store': {
          type: 'CreateUserRequest',
          imports: ['import { CreateUserRequest } from "#types/requests"']
        }
      }
    }
    type RoutesScannerRules = {
        skip: string[];
        response: Record<string, ScannedRoute["response"]>;
        request: Record<string, ScannedRoute["response"]>;
    }
    Index

    Properties

    skip response request

    Properties

    skip: string[]

    An array of route names or controller+method paths to skip from processing. Useful for excluding routes that don't need type generation.

    response: Record<string, ScannedRoute["response"]>

    Define custom response types for specific routes by their name or controller+method path. Overrides automatic type inference.

    request: Record<string, ScannedRoute["response"]>

    Define custom request data types for specific routes by their name or controller+method path. Overrides automatic type inference.

    Settings

    Member Visibility

    On This Page

    Properties