Skip to content

unwrapEntity

unwrapEntity transforme une entité en objet simple, en déballant les valeurs des NewType et en exposant ses métadonnées. Par défaut, les valeurs sont déballées telles quelles. Vous pouvez fournir un transformer (ex: toNative, toJSON) pour projeter les valeurs pendant le déballage.

Exemple interactif

Syntaxe

Signature classique

typescript
function unwrapEntity(
	entity: Entity,
	params?: { transformer?: TransformerFunction }
): UnwrapEntity<Entity, TransformerFunction>

Parametres

  • entity : L'entité à déballer.
  • params : Paramètres optionnels.
  • params.transformer : Transformateur appliqué à chaque valeur déballée.

Valeur de retour

Un objet readonly contenant les propriétés déballées, plus _entityName et _flags si présents.

Type utilitaire

typescript
type UnwrappedUser = C.UnwrapEntity<UserEntity>;
type UnwrappedUserJSON = C.UnwrapEntity<UserEntity, TransformerFunction<"toJSON">>;

Voir aussi

Diffusé sous licence MIT.