#ctx.exit()

Finaliza la ejecución del flujo de eventos actual; los pasos posteriores no se ejecutarán. Se utiliza comúnmente cuando no se cumplen las condiciones de negocio, el usuario cancela o ocurre un error irrecuperable.

#Casos de uso

ctx.exit() se utiliza generalmente en los siguientes contextos donde se puede ejecutar JS:

Diferencia con ctx.exitAll(): ctx.exit() solo finaliza el flujo de eventos actual; otros flujos de eventos bajo el mismo evento no se ven afectados. ctx.exitAll() finaliza el flujo de eventos actual, así como cualquier flujo de eventos posterior bajo el mismo evento que aún no se haya ejecutado.

#Definición de tipo

exit(): never;

Al llamar a ctx.exit() se lanza una excepción interna FlowExitException, que es capturada por el motor de flujos para detener la ejecución del flujo de eventos actual. Una vez invocado, las sentencias restantes en el código JS actual no se ejecutarán.

#Comparación con ctx.exitAll()

#Ejemplos

#Salir al cancelar el usuario

// En una ventana modal de confirmación, finalizar el flujo de eventos si el usuario hace clic en cancelar
if (!confirmed) {
  ctx.message.info('Operación cancelada');
  ctx.exit();
}

#Salir cuando falla la validación de parámetros

// Notificar y finalizar cuando la validación falle
if (!params.value || params.value.length < 3) {
  ctx.message.error('Parámetros inválidos, la longitud debe ser al menos 3');
  ctx.exit();
}

#Salir cuando no se cumplen las condiciones de negocio

// Finalizar si no se cumplen las condiciones; los pasos posteriores no se ejecutarán
const record = ctx.model?.getValue?.();
if (!record || record.status !== 'draft') {
  ctx.notification.warning({ message: 'Solo se pueden enviar borradores' });
  ctx.exit();
}

#Elección entre ctx.exit() y ctx.exitAll()

// Solo el flujo de eventos actual necesita salir → Use ctx.exit()
if (!params.valid) {
  ctx.message.error('Parámetros inválidos');
  ctx.exit();  // Otros flujos de eventos no se ven afectados
}

// Es necesario finalizar todos los flujos de eventos posteriores bajo el evento actual → Use ctx.exitAll()
if (!ctx.model?.context?.getPermission?.()) {
  ctx.notification.warning({ message: 'Permisos insuficientes' });
  ctx.exitAll();  // Tanto el flujo de eventos actual como los flujos de eventos posteriores bajo el mismo evento finalizan
}

#Salir según la elección del usuario tras la confirmación en una ventana modal

const ok = await ctx.modal?.confirm?.({
  title: 'Confirmar eliminación',
  content: 'Esta acción no se puede deshacer. ¿Desea continuar?',
});
if (!ok) {
  ctx.message.info('Cancelado');
  ctx.exit();
}

#Notas

• Después de llamar a ctx.exit(), el código posterior en el JS actual no se ejecutará; se recomienda explicar el motivo al usuario a través de ctx.message, ctx.notification o una ventana modal antes de llamarlo.
• Normalmente no es necesario capturar FlowExitException en el código de negocio; deje que el motor de flujos lo gestione.
• Si necesita finalizar todos los flujos de eventos posteriores bajo el evento actual, utilice ctx.exitAll().

#Relacionado

• ctx.exitAll(): Finaliza el flujo de eventos actual y los flujos de eventos posteriores bajo el mismo evento.
• ctx.message: Mensajes de aviso.
• ctx.modal: Ventanas modales de confirmación.