Блог

Главная - Вопросы по программированию - Динамические параметры машинописного текста и тип возвращаемого значения

Динамические параметры машинописного текста и тип возвращаемого значения

#typescript

Вопрос:

Я разрабатываю приложение Angular, которое должно взаимодействовать с серверной частью, имеющей некоторые ограничения безопасности, с которыми мне приходится сталкиваться при каждом вызове. Чтобы облегчить работу с этими вызовами, я создал метод-оболочку, подобный этому:

 type ApiResponse<T = any> = {
  status: number,
  data: T,
  error?: string
}

type ApiCall<T=any> = (...args: any[]) => ApiResponse<T>;

const makeApiCall = <T extends ApiCall>(apiCall: T, ...params: Parameters<T>): ReturnType<T> => {
  // Execute the "apiCall" method with the parameters, deal with restrictions, parse the response etc
}

Итак, допустим, у меня есть 2 вызова API (они могут иметь любое количество параметров и типов):

 const f1: ApiCall<string> = (a: number, b: string) => {
  // Do logic
  return {
    status: 200,
    data: "Data sample"
  }
}

const f2: ApiCall<string[]> = (a: string, b: string, c: number, d: number) => {
  // Do logic
  return {
    status: 200,
    data: [ a, b ]
  }
}

Я могу использовать оболочку для их запуска:

 makeApiCall(f1, 2, 4);

makeApiCall(f2, "String", "Another", 10, 20);

Однако ничто не мешает мне отправить неправильный номер или тип параметров, например:

 makeApiCall(f1, 2, 4, "WRONG PARAMETER");

makeApiCall(f2, "Wrong number and type of params", 10, true);

Можно ли обеспечить безопасность типов с помощью приведенных выше определений, чтобы компилятор Typescript показывал подсказки и ошибки при использовании оболочки?

Заранее спасибо,

Ответ №1:

Старайтесь избегать объявления явных общих параметров. TS должен выводить все типы. Пусть он делает тяжелую работу 🙂

 type ApiResponse<T> = {
    status: number,
    data: T,
    error?: string
}

type Fn = (...args: any[]) => any

const makeApiCall = <
    F extends Fn
>(apiCall: F, ...params: Parameters<F>): ReturnType<F> =>
    apiCall(...params)

const f1 = (a: number, b: string) => {
    // Do logic
    return {
        status: 200,
        data: [a, b]
    }
}

const f2 = (a: string, b: string, c: number, d: number) => {
    // Do logic
    return {
        status: 200,
        data: [a, b]
    }
}

/**
 * Ok
 */
// Return -> {  status: number;  data: (string|number)[];  }
const result1 = makeApiCall(f1, 42, 'str');

// Return -> {  status: number;  data: string[];  }
const result2 = makeApiCall(f2, "String", "Another", 10, 20);


/**
 * Errors
 */
makeApiCall(f1, 2, 4); // expected error


makeApiCall(f1, 2, 4, "WRONG PARAMETER"); // expected error

makeApiCall(f2, "Wrong number and type of params", 10, true); // expected error

Игровая площадка

Метки: