Documentation
    Preparing search index...

    Type Alias RoutesListItem

    The route data structure accepted by the routes scanner when initiating the scanning process. This represents the raw route definition before analysis.

    const routeItem: RoutesListItem = {
      name: 'users.store',
      pattern: '/users',
      domain: 'root',
      methods: ['POST'],
      controllerReference: {
        importExpression: "() => import('#controllers/users_controller')",
        method: 'store'
      },
      tokens: [{ val: '/users', old: '/users', type: 0, end: '' }]
    }
    type RoutesListItem = {
        name?: string;
        pattern: string;
        domain: string;
        methods: string[];
        controllerReference?: { importExpression: string; method?: string };
        tokens: { val: string; old: string; type: 0 | 1 | 2 | 3; end: string }[];
    }
    Index

    Properties

    name? pattern domain methods controllerReference? tokens

    Properties

    name?: string

    Optional unique name for the route

    pattern: string

    Route pattern with parameter placeholders

    domain: string

    Domain on which the route is registered

    methods: string[]

    HTTP methods accepted by this route

    controllerReference?: { importExpression: string; method?: string }

    Controller reference information (if controller-based route)

    Type Declaration

    • importExpression: string

      Dynamic import expression for the controller

    • Optionalmethod?: string

      Specific controller method to call

    tokens: { val: string; old: string; type: 0 | 1 | 2 | 3; end: string }[]

    Parsed route tokens for URI construction

    Settings

    Member Visibility

    On This Page

    Properties