Stone.js API
    Preparing search index...

    Interface RoutingOptions

    Options for the Routing decorator, extending router configuration.

    interface RoutingOptions {
        bindings?: Record<string, IBoundModel | BindingResolver>;
        composableProps?: string[];
        defaults?: Record<string, unknown>;
        definitions?: RouteDefinition<StoneIncomingEvent, unknown>[];
        dependencyResolver?: DependencyResolver;
        dispatchers?: IDispatchers<IncomingEventType, OutgoingResponseType>;
        eventEmitter?: IEventEmitter;
        matchers?: IMatcher<StoneIncomingEvent, unknown>[];
        maxDepth?: number;
        maxUriLength?: number;
        middleware?: MixedPipe<StoneIncomingEvent, unknown>[];
        navigator?: RouterNavigator;
        prefix?: string;
        protocolPolicy?: ProtocolPolicy;
        rules?: Record<string, RegExp>;
        skipMiddleware?: boolean;
        strict?: boolean;
    }

    Hierarchy

    Index
    bindings? composableProps? defaults? definitions? dependencyResolver? dispatchers? eventEmitter? matchers? maxDepth? maxUriLength? middleware? navigator? prefix? protocolPolicy? rules? skipMiddleware? strict?
    bindings?: Record<string, IBoundModel | BindingResolver>

    Custom function bindings for specific route behaviors.

    composableProps?: string[]

    Module props that compose down a group instead of being replaced by the child's value.

    Contributed by modules through their blueprints (stone.router.composableProps), never named by the router itself: @stone-js/authz declares authz composable so a group policy holds for every child on top of the child's own.

    defaults?: Record<string, unknown>

    Default parameter values for routes.

    definitions?: RouteDefinition<StoneIncomingEvent, unknown>[]

    Array of route definitions to be included in the router.

    dependencyResolver?: DependencyResolver

    Resolver used to resolve dependencies.

    dispatchers?: IDispatchers<IncomingEventType, OutgoingResponseType>

    Dispatchers used for handling callable and controller-based routes.

    eventEmitter?: IEventEmitter

    Custom event emitter for handling application events.

    matchers?: IMatcher<StoneIncomingEvent, unknown>[]

    List of matchers used to validate and match routes.

    maxDepth?: number

    Maximum depth allowed in route definitions.

    maxUriLength?: number

    Maximum request URI length (characters) accepted before matching. Defaults to 2048.

    middleware?: MixedPipe<StoneIncomingEvent, unknown>[]

    List of middleware applied during route resolution.

    navigator?: RouterNavigator

    Performs the platform's navigation effect. Defaults to the browser navigator (History API plus a navigation event); a native application supplies its own.

    prefix?: string

    Base path prefix applied to all routes.

    protocolPolicy?: ProtocolPolicy

    Protocol Policy for all routes.

    rules?: Record<string, RegExp>

    Custom rules for route matching, defined as regular expressions.

    skipMiddleware?: boolean

    Skips middleware execution for specific routes.

    strict?: boolean

    Enables strict path matching.

    Settings
    Member Visibility

    On This Page
    Properties