Skip to content

right ​

Construit un Right en associant une information métier obligatoire (string littérale) et un payload optionnel. C'est la brique de base pour signaler un succès contextualisé.

Exemple interactif ​

Syntaxe ​

typescript
function right<
	GenericInformation extends string, 
	const GenericInput extends unknown = undefined
>(
  information: GenericInformation,
  value?: GenericInput
): Right<GenericInformation, GenericInput>

Paramètres ​

  • information : string littérale qui décrit précisément le succès (ex. "user.created"). Cette information reste dans le type.
  • input : payload optionnel associé au succès. Si omis, le type inféré devient undefined.

Valeur de retour ​

Un Right<Information, Value> qui peut être discriminé avec E.isRight, E.hasInformation ou E.whenHasInformation.

Bonnes pratiques ​

  • Prenez l'habitude d'utiliser des chaînes descriptives ("user.created", "invoice.validated") pour simplifier le pattern matching.
  • Ne partagez pas les mêmes chaînes entre plusieurs cas métiers différents.
  • Combinez right avec left afin que chaque branche d'une fonction retourne un Either homogène.

Voir aussi ​

  • result – Right de résultat neutre, ni positif ni négatif.
  • success – Raccourci spécialisé pour right("success", value).
  • ok – Variante sans payload (Right<"ok">).
  • hasInformation – Type guard sur l'information métier.

Diffusé sous licence MIT.