#ctx.route

Informações de correspondência da rota atual, correspondendo ao conceito de route do React Router. É usado para obter a configuração da rota correspondente atual, parâmetros e muito mais. Geralmente é usado em conjunto com ctx.router e ctx.location.

#Cenários de uso

Observação: ctx.route está disponível apenas em ambientes RunJS que contenham um contexto de roteamento (como JSBlocks dentro de uma página, páginas de Fluxo, etc.). Pode ser nulo em contextos puramente de backend ou sem roteamento (como fluxos de trabalho).

#Definição de tipo

type RouteOptions = {
  name?: string;   // Identificador único da rota
  path?: string;   // Modelo da rota (ex: /admin/:name)
  params?: Record<string, any>;  // Parâmetros da rota (ex: { name: 'users' })
  pathname?: string;  // Caminho completo da rota atual (ex: /admin/users)
};

#Campos comuns

#Relação com ctx.router e ctx.location

ctx.route foca na "configuração da rota correspondente", enquanto ctx.location foca na "localização atual da URL". Juntos, eles fornecem uma descrição completa do estado de roteamento atual.

#Exemplos

#Lendo o pathname

// Exibe o caminho atual
ctx.message.info('Página atual: ' + ctx.route.pathname);

#Ramificação baseada em params

// params.name geralmente é o UID da página atual (ex: identificador de uma página de fluxo)
if (ctx.route.params?.name === 'users') {
  // Executa uma lógica específica na página de gerenciamento de usuários
}

#Exibindo em uma página de Fluxo

<div>
  <h1>Página atual - {ctx.route.pathname}</h1>
  <p>Identificador da rota: {ctx.route.params?.name}</p>
</div>

#Relacionado

• ctx.router: Navegação de rota. Quando ctx.router.navigate() altera o caminho, o ctx.route será atualizado adequadamente.
• ctx.location: Localização atual da URL (pathname, search, hash, state), usado em conjunto com ctx.route.