#ctx.route

The current route matching information, corresponding to the route concept in React Router. It is used to retrieve the current matching route configuration, parameters, and more. It is typically used in conjunction with ctx.router and ctx.location.

#Use Cases

Note: ctx.route is only available in RunJS environments that contain a routing context (such as JSBlocks within a page, Flow pages, etc.). It may be null in pure backend or non-routing contexts (such as background workflows).

#Type Definition

type RouteOptions = {
  name?: string;   // Unique route identifier
  path?: string;   // Route template (e.g., /admin/:name)
  params?: Record<string, any>;  // Route parameters (e.g., { name: 'users' })
  pathname?: string;  // Full path of the current route (e.g., /admin/users)
};

#Common Fields

#Relationship with ctx.router and ctx.location

ctx.route focuses on the "matched route configuration," while ctx.location focuses on the "current URL location." Together, they provide a complete description of the current routing state.

#Examples

#Reading pathname

// Display the current path
ctx.message.info('Current Page: ' + ctx.route.pathname);

#Branching based on params

// params.name is typically the current page UID (e.g., a Flow page identifier)
if (ctx.route.params?.name === 'users') {
  // Execute specific logic on the user management page
}

#Displaying in a Flow page

<div>
  <h1>Current Page - {ctx.route.pathname}</h1>
  <p>Route Identifier: {ctx.route.params?.name}</p>
</div>

#Related

• ctx.router: Route navigation. When ctx.router.navigate() changes the path, ctx.route will update accordingly.
• ctx.location: Current URL location (pathname, search, hash, state), used in conjunction with ctx.route.