Convertir un objet en interface en TypeScript

Question

Je cherche à faire un cast dans mon code à partir du corps d'une requête dans express (en utilisant le middleware body-parser) vers une interface, mais cela n'applique pas la sécurité des types.

Voici mon interface:

export interface IToDoDto {
  description: string;
  status: boolean;
};

Voici le code où j'essaie de faire le cast:

@Post()
addToDo(@Response() res, @Request() req) {
  const toDo: IToDoDto =  req.body; // <<< cast ici
  this.toDoService.addToDo(toDo);
  return res.status(HttpStatus.CREATED).end();
}

Et enfin, la méthode de service qui est appelée:

public addToDo(toDo: IToDoDto): void {
  toDo.id = this.idCounter;
  this.todos.push(toDo);
  this.idCounter++;
}

Je peux passer n'importe quels arguments, même ceux qui ne correspondent pas du tout à la définition de l'interface, et ce code fonctionnera très bien. Je m'attendrais à ce que, si le cast du corps de la réponse vers l'interface n'est pas possible, une exception soit lancée à l'exécution comme en Java ou C#.

J'ai lu que en TypeScript, le cast n'existe pas, seulement l'Assertion de Type, donc cela indiquera seulement au compilateur qu'un objet est de type x, alors... ai-je tort? Quelle est la bonne façon de garantir la sécurité des types ?

Answer 1

Il n'y a pas de casting en javascript, donc vous ne pouvez pas déclencher d'erreur si le "casting échoue".
Typescript prend en charge le casting mais cela ne concerne que le temps de compilation, et vous pouvez le faire comme ceci :

const toDo =  req.body;
// ou
const toDo = req.body as IToDoDto;

Vous pouvez vérifier à l'exécution si la valeur est valide et si ce n'est pas le cas déclencher une erreur, par exemple :

function isToDoDto(obj: any): obj is IToDoDto {
    return typeof obj.description === "string" && typeof obj.status === "boolean";
}

@Post()
addToDo(@Response() res, @Request() req) {
    if (!isToDoDto(req.body)) {
        throw new Error("requête invalide");
    }

    const toDo = req.body as IToDoDto;
    this.toDoService.addToDo(toDo);
    return res.status(HttpStatus.CREATED).end();
}

---

Editer

Comme l'a souligné @huyz, il n'est pas nécessaire d'effectuer une assertion de type car isToDoDto est un type de garde, donc cela devrait suffire :

if (!isToDoDto(req.body)) {
    throw new Error("requête invalide");
}

this.toDoService.addToDo(req.body);

Answer 2

Voici une autre façon de forcer une conversion de type même entre des types et des interfaces incompatibles où le compilateur TS se plaint normalement:

export function forceCast(input: any): T {

  // ... effectuer des vérifications en temps d'exécution ici

  // @ts-ignore <-- force le compilateur TS à compiler cela tel quel
  return input;
}

Ensuite, vous pouvez l'utiliser pour forcer la conversion d'objets vers un certain type:

import { forceCast } from './forceCast';

const randomObject: any = {};
const typedObject = forceCast(randomObject);

Notez que j'ai laissé de côté la partie où vous êtes censé effectuer des vérifications en temps d'exécution avant la conversion pour réduire la complexité. Ce que je fais dans mon projet, c'est compiler tous mes fichiers d'interfaces .d.ts en schémas JSON et utiliser ajv pour valider en temps d'exécution.

Answer 3

Si cela aide quelqu'un, j'avais un problème où je voulais traiter un objet comme un autre type avec une interface similaire. J'ai essayé ce qui suit:

N'a pas passé le linting

const x = new Obj(a as b);

Le linter se plaignait que a manquait de propriétés qui existaient sur b. En d'autres termes, a avait certaines propriétés et méthodes de b, mais pas toutes. Pour contourner cela, j'ai suivi la suggestion de VS Code:

Passé le linting et les tests

const x = new Obj(a as unknown as b);

Notez que si votre code tente d'appeler l'une des propriétés qui existe sur le type b qui n'est pas implémenté sur le type a, vous devriez remarquer une erreur d'exécution.