Передати об’єкт на інтерфейс у TypeScript

Я намагаюся зробити привід у своєму коді з тіла запиту в експрес-форматі (за допомогою проміжного програмного забезпечення body-parser) до інтерфейсу, але це не забезпечує безпеки типу.

Це мій інтерфейс:

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

Це код, де я намагаюся зробити акторський склад:

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

І нарешті, метод служби, який називається:

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

Я можу передати будь-які аргументи, навіть ті, які не відповідають визначенню інтерфейсу , і цей код буде чудово працювати. Я би очікував, що якщо приведення з тіла відповіді до інтерфейсу неможливе, то під час виконання, як Java або C #, буде створено виняток.

Я читав, що в TypeScript кастинг не існує, існує лише твердження типу, тому він лише повідомляє компілятору, що об’єкт має тип x, тож ... Я помиляюся? Який правильний спосіб забезпечити та забезпечити безпеку типу?

У javascript немає кастингу, тому ви не можете кидати, якщо "кастинг не вдається".
Typescript підтримує кастинг, але це лише для часу компіляції, і ви можете зробити це так:

const toDo = <IToDoDto> req.body;
// or
const toDo = req.body as IToDoDto;

Ви можете перевірити під час виконання, чи є значення дійсним, а якщо не, вивести помилку, тобто:

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("invalid request");
    }

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

Редагувати

Як зазначив @huyz, немає потреби в твердженні типу, оскільки isToDoDtoце захист типу, тому цього має бути достатньо:

if (!isToDoDto(req.body)) {
    throw new Error("invalid request");
}

this.toDoService.addToDo(req.body);

Ось ще один спосіб примусити типову передачу навіть між несумісними типами та інтерфейсами, на які зазвичай скаржиться компілятор TS:

export function forceCast<T>(input: any): T {

  // ... do runtime checks here

  // @ts-ignore <-- forces TS compiler to compile this as-is
  return input;
}

Потім ви можете використовувати його, щоб примусити кинути об'єкти до певного типу:

import { forceCast } from './forceCast';

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

Зауважте, що я залишив ту частину, яку ви повинні виконувати перевірки часу виконання, перед тим, як робити трансляцію, для зменшення складності. Що я роблю у своєму проекті, це компіляція всіх моїх .d.tsфайлів інтерфейсу у схеми JSON та використання ajvдля перевірки під час виконання.

Якщо це комусь допомагає, у мене виникла проблема, коли я хотів розглядати об’єкт як інший тип із подібним інтерфейсом. Я спробував наступне:

Не пройшов футеровку

const x = new Obj(a as b);

Лінтер скаржився на aвідсутність властивостей, які існували на b. Іншими словами, aмав деякі властивості та методи b, але не всі. Щоб обійти це, я слідував пропозиції VS Code:

Пройшов лінійку та випробування

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

Зверніть увагу, що якщо ваш код намагається викликати одне з властивостей, яке існує для типу, bщо не реалізовано для типу a, ви повинні усвідомити помилку виконання.