@mojojs/core
    Preparing search index...

    Class Router

    Router class.

    Hierarchy (View Summary)

    Index
    constructor
    _lookupIndex _parent _root cache children conditions controllerPaths controllers customName defaultName methods pattern requirements types underRoute websocketRoute
    parent root
    _branch _getLookupIndex _getPlan _walk addChild addCondition addType any delete dispatch find get hasWebSocket isEndpoint lookup name options patch plot post put query remove render requires suggestedMethod to under warmup websocket

    _lookupIndex

    _lookupIndex: RouteIndex | undefined = undefined

    _parent

    _parent: WeakRef<Route> | undefined = undefined

    _root

    _root: WeakRef<Router> | undefined = undefined
    cache: Cache<Plan> | null = ...

    Routing cache.

    children: Route[] = []

    The children of this route, used for nesting routes.

    conditions: Record<string, RouteCondition> = {}

    Contains all available conditions.

    controllerPaths: string[] = []

    Directories to look for controllers in, first one has the highest precedence.

    controllers: Record<string, any> = {}

    Already loaded controllers.

    customName: string | undefined = undefined

    Custom route name, if defined.

    defaultName: string | undefined = undefined

    Default route name.

    methods: string[] = []

    Restrict HTTP methods this route is allowed to handle, defaults to no restrictions.

    pattern: Pattern = ...

    Pattern for this route.

    requirements: Record<string, any>[] = []

    Activate conditions for this route.

    types: Record<string, PlaceholderType> = ...

    Registered placeholder types, by default only num is already defined.

    underRoute: boolean = false

    Allow under semantics for this route.

    websocketRoute: boolean = false

    Activate websocket semantics for this route.

    • get parent(): Route | undefined

      The parent of this route.

      Returns Route | undefined

    • set parent(parent: Route | undefined): void

      Parameters

      • parent: Route | undefined

      Returns void

    • get root(): Router | undefined

      Return the Router object this route is a descendant of.

      Returns Router | undefined

    • set root(root: Router | undefined): void

      Parameters

      Returns void

    _branch

    _getLookupIndex

    • _getLookupIndex(): RouteIndex

      Returns RouteIndex

    _getPlan

    _walk

    • _walk(plan: Plan, route: Route, spec: RouteSpec): Promise<boolean>

      Parameters

      Returns Promise<boolean>

    • Add a child to this route.

      Parameters

      Returns Route

    • Register a condition.

      Parameters

      • name: string
      • fn: RouteCondition

      Returns this

    • Register a placeholder type.

      Parameters

      Returns this

    • Generate route matching any of the listed HTTP request methods or all.

      Parameters

      Returns Route

      // Route with pattern and destination
      route.any('/user').to('User#whatever');

      // Route with HTTP methods, pattern, restrictive placeholders and destination
      route.any(['DELETE', 'PUT'], '/:foo', {foo: /\w+/}).to('Foo#bar');

      // Route with pattern, name and destination
      route.any('/:foo').name('foo_route').to('Foo#bar');

      // Route with pattern, condition and destination
      route.any('/').requires({agent: /Firefox/}).to('Foo#bar');

      // Route with pattern and a closure as destination
      route.any('/:foo', async ctx => ctx.render({text: 'Hello World!'}));

    • Generate route matching only DELETE requests.

      Parameters

      Returns Route

      // Route with destination
      route.delete('/user').to('User#remove');

    • Match routes and dispatch to actions with and without controllers.

      Parameters

      Returns Promise<boolean>

    • Find child route by name, custom names have precedence over automatically generated ones.

      Parameters

      • name: string

      Returns Route | null

    • Generate route matching only GET requests.

      Parameters

      Returns Route

      // Route with destination
      route.get('/user').to('User#show');

    • Check if this route has a WebSocket ancestor and cache the result for future checks.

      Returns boolean

    • Check if this route qualifies as an endpoint.

      Returns boolean

    • Find route by name and cache all results for future lookups.

      Parameters

      • name: string

      Returns Route | null

    • The name of this route, defaults to an automatically generated name based on the route pattern. Note that the name current is reserved for referring to the current route.

      Parameters

      • name: string

      Returns this

    • Generate route matching only OPTIONS requests.

      Parameters

      Returns Route

      // Route with destination
      route.options('/user').to('User#overview');

    • Generate route matching only PATCH requests.

      Parameters

      Returns Route

      // Route with destination
      route.patch('/user').to('User#update');

    • Plot a route.

      Parameters

      • spec: RouteSpec

      Returns Promise<Plan | null>

    post

    • post(...args: RouteArguments): Route

      Generate route matching only POST requests.

      Parameters

      Returns Route

      // Route with destination
      route.post('/user').to('User#create');

    • Generate route matching only PUT requests.

      Parameters

      Returns Route

      // Route with destination
      route.put('/user').to('User#replace');

    • Generate route matching only QUERY requests.

      Parameters

      Returns Route

      // Route with destination
      route.query('/search').to('Search#index');

    • Remove route from parent.

      Returns this

    • Render route with parameters into a path.

      Parameters

      • values: {} = {}

      Returns string

    • Activate conditions for this route. Note that this automatically disables the routing cache, since conditions are too complex for caching.

      Parameters

      • condition: string
      • requirement: Record<string, any>

      Returns this

    • Suggested HTTP method for reaching this route, GET and POST are preferred.

      Returns string

    • Set default parameters for this route.

      Parameters

      • ...targets: (string | Record<string, any> | MojoAction)[]

      Returns this

    • Generate route for a nested route with its own intermediate destination.

      Parameters

      Returns Route

      // Intermediate destination and prefix shared between two routes
      const auth = app.under('/user').to('User#auth');
      auth.get('/show').to('User#show');
      auth.post('/create').to('User#create');

    • Prepare controllers for routing.

      Returns Promise<void>

    • Generate route matching only WebSocket handshake requests.

      Parameters

      Returns Route

      // Route with destination
      app.websocket('/echo').to('Example#echo');

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods