#ctx.exit()

Termine l'exécution du flux d'événements actuel ; les étapes suivantes ne seront pas exécutées. Il est couramment utilisé lorsque les conditions métier ne sont pas remplies, que l'utilisateur annule ou qu'une erreur irrécupérable survient.

#Scénarios d'utilisation

ctx.exit() est généralement utilisé dans les contextes suivants où du code JS peut être exécuté :

Différence avec ctx.exitAll() : ctx.exit() termine uniquement le flux d'événements actuel ; les autres flux d'événements associés au même événement ne sont pas affectés. ctx.exitAll() termine le flux d'événements actuel ainsi que tous les flux d'événements suivants du même événement qui n'ont pas encore été exécutés.

#Définition du type

exit(): never;

L'appel à ctx.exit() lève une exception interne FlowExitException, qui est capturée par le moteur de flux pour arrêter l'exécution du flux d'événements actuel. Une fois appelé, les instructions restantes dans le code JS actuel ne seront pas exécutées.

#Comparaison avec ctx.exitAll()

#Exemples

#Quitter en cas d'annulation de l'utilisateur

// Dans une fenêtre de confirmation, termine le flux d'événements si l'utilisateur clique sur annuler
if (!confirmed) {
  ctx.message.info('Opération annulée');
  ctx.exit();
}

#Quitter en cas d'échec de validation des paramètres

// Affiche un message et termine l'exécution si la validation échoue
if (!params.value || params.value.length < 3) {
  ctx.message.error('Paramètres invalides, la longueur doit être d\'au moins 3');
  ctx.exit();
}

#Quitter lorsque les conditions métier ne sont pas remplies

// Termine si les conditions ne sont pas remplies ; les étapes suivantes ne s'exécuteront pas
const record = ctx.model?.getValue?.();
if (!record || record.status !== 'draft') {
  ctx.notification.warning({ message: 'Seuls les brouillons peuvent être soumis' });
  ctx.exit();
}

#Choisir entre ctx.exit() et ctx.exitAll()

// Seul le flux d'événements actuel doit s'arrêter → Utiliser ctx.exit()
if (!params.valid) {
  ctx.message.error('Paramètres invalides');
  ctx.exit();  // Les autres flux d'événements ne sont pas affectés
}

// Nécessité de terminer tous les flux d'événements suivants pour cet événement → Utiliser ctx.exitAll()
if (!ctx.model?.context?.getPermission?.()) {
  ctx.notification.warning({ message: 'Permissions insuffisantes' });
  ctx.exitAll();  // Le flux d'événements actuel et les flux suivants du même événement sont terminés
}

#Quitter selon le choix de l'utilisateur après une confirmation modale

const ok = await ctx.modal?.confirm?.({
  title: 'Confirmer la suppression',
  content: 'Cette action est irréversible. Voulez-vous continuer ?',
});
if (!ok) {
  ctx.message.info('Annulé');
  ctx.exit();
}

#Remarques

• Après l'appel à ctx.exit(), le code suivant dans le JS actuel ne sera pas exécuté ; il est recommandé d'expliquer la raison à l'utilisateur via ctx.message, ctx.notification ou une fenêtre modale avant l'appel.
• Il n'est généralement pas nécessaire de capturer FlowExitException dans votre code métier ; laissez le moteur de flux s'en charger.
• Si vous devez terminer tous les flux d'événements suivants associés à l'événement actuel, utilisez ctx.exitAll().

#Voir aussi

• ctx.exitAll() : Termine le flux d'événements actuel et les flux d'événements suivants du même événement.
• ctx.message : Messages d'information.
• ctx.modal : Fenêtres modales de confirmation.