Aller au contenu
English

HarnessHookOptions

import type { HarnessHookOptions } from "@elie-laloum/outpost";
  • onRequis
    Phase
    Point de la boucle où le hook s’exécute.
  • nameOptionnel
    string | undefined
    Nom utilisé pour les diagnostics, le nom de la phase par défaut.
  • runRequis
    (input: HarnessHookInput<Phase>) => HarnessHookResult<Phase> | Promise<HarnessHookResult<Phase>>
    Fonction de contrôle de cette phase. Les hooks d’une phase s’exécutent dans l’ordre de déclaration ; une exception fait échouer le tour, et une décision invalide le fait échouer avec le code configuration.
export interface HarnessHookOptions<Phase extends HarnessHookPhase> {
  readonly on: Phase;
  readonly name?: string;
  run(
    input: HarnessHookInput<Phase>,
  ): HarnessHookResult<Phase> | Promise<HarnessHookResult<Phase>>;
}