Skip to content

result

Construit un Right de résultat neutre : ni positif ni négatif, simplement un résultat contextualisé avec une information métier et un payload.

Exemple interactif

Syntaxe

Classique

typescript
function result<
  GenericInformation extends string,
  const GenericValue extends unknown = undefined
>(
  information: GenericInformation,
  value: GenericValue
): Result<GenericInformation, GenericValue>

Currifiée

typescript
function result<
  GenericInformation extends string,
  const GenericValue extends unknown = undefined
>(
  information: GenericInformation
): (value: GenericValue) => Result<GenericInformation, GenericValue>

Paramètres

  • information : String littérale qui décrit le résultat produit ("invoice.total", "user.skipped", etc.).
  • value : Payload associé à ce résultat. Passez undefined explicitement quand le résultat n'a pas de payload.

Valeur de retour

Un Result<Information, Value>, c'est-à-dire un Right spécialisé taggé avec le kind supplémentaire result.

Quand seul information est fourni, result retourne une fonction en attente de value, utile dans pipe.

Voir aussi

  • right – Constructeur générique de Right avec information métier.
  • success – Raccourci pour les issues explicitement positives.
  • unwrapRightOrThrow – Unwrap immédiat du payload d'un Right.

Diffusé sous licence MIT.