Documentation
    Preparing search index...

    Type Alias RouteJSON

    Complete route definition with all metadata, handlers, and execution context

    type RouteJSON = {
        execute: (
            route: RouteJSON,
            resolver: ContainerResolver<any>,
            ctx: HttpContext,
            errorResponder: ServerErrorHandler["handle"],
        ) => any;
        name?: string;
        pattern: string;
        handler: StoreRouteHandler;
        middleware: Middleware<StoreRouteMiddleware>;
        meta: Record<string, any>;
        tokens: MatchItRouteToken[];
        methods: string[];
        domain: string;
        matchers: RouteMatchers;
    }
    Index

    Properties

    execute name? pattern handler middleware meta tokens methods domain matchers

    Properties

    execute: (
        route: RouteJSON,
        resolver: ContainerResolver<any>,
        ctx: HttpContext,
        errorResponder: ServerErrorHandler["handle"],
    ) => any

    The execute function to execute the route middleware and the handler

    name?: string

    A unique name for the route

    pattern: string

    Route URI pattern

    handler: StoreRouteHandler

    Route handler

    middleware: Middleware<StoreRouteMiddleware>

    Route middleware

    meta: Record<string, any>

    Additional metadata associated with the route

    tokens: MatchItRouteToken[]

    Tokens to be used to construct the route URL

    methods: string[]

    HTTP methods, the route responds to.

    domain: string

    The domain for which the route is registered.

    matchers: RouteMatchers

    Matchers for route params.

    Settings

    Member Visibility

    On This Page

    Properties