Typescript: Ковариантность и контравариантность
Когда мы присваиваем значение или передаем аргументы в вызов функции, проверка типов TypeScript проверяет типы на совместимость. При передаче аргументов в функцию проверка выполняется и для типов параметров, и для возвращаемых типов.
Если мы передадим возвращающую number функцию для колбека функции-сортировки, которая ожидает возврата -1 | 0 | 1, то получим ошибку Type 'number' is not assignable to type '0 | 1 | -1'.:
type ComparatorCallback = (item1: number, item2: number) => -1 | 0 | 1
declare function sort(arr: Array<number>, callback: ComparatorCallback): Array<number>
const arr = [1, 2, 3];
const comparator = (item1: number, item2: number) => Math.sign(item1 - item2);
// (item1: number, item2: number) => number;
sort(arr, comparator); // Error: Type 'number' is not assignable to type '0 | 1 | -1'.Множество значений из объединения трех литеральных типов -1 | 0 | 1 является подмножеством number. Но из ошибки можно понять, что возвращаемый тип должен быть либо таким же, либо более узким. Такое поведение проверки типов называется ковариантностью.
Чтобы решить проблему с ComparatorCallback, нам нужно сузить возвращаемый тип функции comparator до -1 | 0 | 1 или более узкого. Перепишем код без Math.sign, чтобы вернуть нужный тип:
type ComparatorCallback = (item1: number, item2: number) => -1 | 0 | 1
declare function sort(arr: Array<number>, callback: ComparatorCallback): Array<number>
const arr = [1, 2, 3];
const comparator = (item1: number, item2: number) => {
// (item1: number, item2: number) => -1 | 0 | 1;
if (item1 === item2) {
return 0;
}
return item1 > item2 ? 1 : -1;
};
sort(arr, comparator);Теперь код проходит проверку типов. Возвращаемый тип comparator стал более узким, чем требуемый в ComparatorCallback.
Для аргументов функции проверка типов выполняется в обратном порядке. Если мы передадим функцию, которая ожидает литеральный тип 1 вместо number, то получим ошибку Type 'number' is not assignable to type '1'.:
type ComparatorCallback = (item1: number, item2: number) => -1 | 0 | 1
declare function sort(arr: Array<number>, callback: ComparatorCallback): Array<number>
const arr = [1, 2, 3];
const comparator = (item1: 1, item2: number) => Math.sign(item1 - item2) as -1 | 0 | 1;
sort(arr, comparator); // Type 'number' is not assignable to type '1'.Тип 1 является подмножеством number. И в нашем примере мы передаем в функцию sort функцию, которая ожидает более узкий тип на входе. Также вы можете обратить внимание, что мы приводим тип возвращаемого значения к -1 | 0 | 1 с помощью ключевого слова as. Нам потребовалось приведение вниз, так как типизация Math.sign возвращает number.
Когда мы передаем аргументы в функцию, то ожидаемые типы параметров должны быть более широкими, чем фактические. Такое поведение проверки типов называется контравариантностью.
Попробуйте самостоятельно объяснить поведение проверки типов через вариантность в следующем примере:
type Formatter = (val: string) => string;
const formatToConcrete: Formatter = (): 'test' => 'test';
const formatToNumber: Formatter = (val: '1') => val; // Error!Ответ
Тип параметров может быть шире, а тип на выходе — уже. В примере formatToConcrete не принимает никаких параметров. Это дает более широкий тип, нежели требуемый string. А возвращает более узкий литеральный тип. formatToNumber ожидает более узкий тип на входе, поэтому и возникает ошибка.Если при работе с TypeScript учитывать наследие JavaScript с утиной типизацией, то все становится на свои места.
Чтобы код не упал с ошибкой, достаточно проверки на наличие полей или методов нужных типов. А чтобы получить гарантии во внешнем мире, нужно, чтобы переменная попадала под внешние ограничения. Для этого тип должен быть более узким или таким же.
Задание
Реализуйте функцию applyTransactions(wallet) и типы Transaction, Wallet. Wallet содержит список транзакций в виде массива элементов типа Transaction и числовой баланс. Transaction содержит метод apply, который принимает баланс и возвращает новый баланс.
Функция applyTransactions(wallet) должна принимать аргумент типа Wallet и возвращать баланс после применения всего списка транзакций. В случае ошибки в одной из транзакций должно вернуться изначальный баланс, и не продолжать применять транзакции.
const wallet: Wallet = {
transactions: [
{
apply: (amount) => amount + 1,
},
],
balance: 0
}
console.log(applyTransactions(wallet)) // 1Полезное
Typescript: Ковариантность и контравариантность
Когда мы присваиваем значение или передаем аргументы в вызов функции, проверка типов TypeScript проверяет типы на совместимость. При передаче аргументов в функцию проверка выполняется и для типов параметров, и для возвращаемых типов.
Если мы передадим возвращающую number функцию для колбека функции-сортировки, которая ожидает возврата -1 | 0 | 1, то получим ошибку Type 'number' is not assignable to type '0 | 1 | -1'.:
type ComparatorCallback = (item1: number, item2: number) => -1 | 0 | 1
declare function sort(arr: Array<number>, callback: ComparatorCallback): Array<number>
const arr = [1, 2, 3];
const comparator = (item1: number, item2: number) => Math.sign(item1 - item2);
// (item1: number, item2: number) => number;
sort(arr, comparator); // Error: Type 'number' is not assignable to type '0 | 1 | -1'.Множество значений из объединения трех литеральных типов -1 | 0 | 1 является подмножеством number. Но из ошибки можно понять, что возвращаемый тип должен быть либо таким же, либо более узким. Такое поведение проверки типов называется ковариантностью.
Чтобы решить проблему с ComparatorCallback, нам нужно сузить возвращаемый тип функции comparator до -1 | 0 | 1 или более узкого. Перепишем код без Math.sign, чтобы вернуть нужный тип:
type ComparatorCallback = (item1: number, item2: number) => -1 | 0 | 1
declare function sort(arr: Array<number>, callback: ComparatorCallback): Array<number>
const arr = [1, 2, 3];
const comparator = (item1: number, item2: number) => {
// (item1: number, item2: number) => -1 | 0 | 1;
if (item1 === item2) {
return 0;
}
return item1 > item2 ? 1 : -1;
};
sort(arr, comparator);Теперь код проходит проверку типов. Возвращаемый тип comparator стал более узким, чем требуемый в ComparatorCallback.
Для аргументов функции проверка типов выполняется в обратном порядке. Если мы передадим функцию, которая ожидает литеральный тип 1 вместо number, то получим ошибку Type 'number' is not assignable to type '1'.:
type ComparatorCallback = (item1: number, item2: number) => -1 | 0 | 1
declare function sort(arr: Array<number>, callback: ComparatorCallback): Array<number>
const arr = [1, 2, 3];
const comparator = (item1: 1, item2: number) => Math.sign(item1 - item2) as -1 | 0 | 1;
sort(arr, comparator); // Type 'number' is not assignable to type '1'.Тип 1 является подмножеством number. И в нашем примере мы передаем в функцию sort функцию, которая ожидает более узкий тип на входе. Также вы можете обратить внимание, что мы приводим тип возвращаемого значения к -1 | 0 | 1 с помощью ключевого слова as. Нам потребовалось приведение вниз, так как типизация Math.sign возвращает number.
Когда мы передаем аргументы в функцию, то ожидаемые типы параметров должны быть более широкими, чем фактические. Такое поведение проверки типов называется контравариантностью.
Попробуйте самостоятельно объяснить поведение проверки типов через вариантность в следующем примере:
type Formatter = (val: string) => string;
const formatToConcrete: Formatter = (): 'test' => 'test';
const formatToNumber: Formatter = (val: '1') => val; // Error!Ответ
Тип параметров может быть шире, а тип на выходе — уже. В примере formatToConcrete не принимает никаких параметров. Это дает более широкий тип, нежели требуемый string. А возвращает более узкий литеральный тип. formatToNumber ожидает более узкий тип на входе, поэтому и возникает ошибка.Если при работе с TypeScript учитывать наследие JavaScript с утиной типизацией, то все становится на свои места.
Чтобы код не упал с ошибкой, достаточно проверки на наличие полей или методов нужных типов. А чтобы получить гарантии во внешнем мире, нужно, чтобы переменная попадала под внешние ограничения. Для этого тип должен быть более узким или таким же.
Задание
Реализуйте функцию applyTransactions(wallet) и типы Transaction, Wallet. Wallet содержит список транзакций в виде массива элементов типа Transaction и числовой баланс. Transaction содержит метод apply, который принимает баланс и возвращает новый баланс.
Функция applyTransactions(wallet) должна принимать аргумент типа Wallet и возвращать баланс после применения всего списка транзакций. В случае ошибки в одной из транзакций должно вернуться изначальный баланс, и не продолжать применять транзакции.
const wallet: Wallet = {
transactions: [
{
apply: (amount) => amount + 1,
},
],
balance: 0
}
console.log(applyTransactions(wallet)) // 1Полезное
Ваше упражнение проверяется по этим тестам
import { expect, expectTypeOf, test } from 'vitest';
import applyTransactions, { type Wallet } from './index';
test('applyTransactions', () => {
const wallet: Wallet = {
balance: 100,
transactions: [
{
apply: (amount: number) => amount + 10,
},
{
apply: (amount: number) => amount - 20,
},
{
apply: (amount: number) => amount + 30,
},
],
};
expect(applyTransactions(wallet)).toBe(120);
expect(wallet.balance).toBe(100);
const wallet2: Wallet = {
balance: 10,
transactions: [
{
apply: (amount: number) => amount + 10,
},
{
apply: () => {
throw new Error('Error');
},
},
{
apply: (amount: number) => amount + 30,
},
],
};
expect(applyTransactions(wallet2)).toBe(10);
expectTypeOf(wallet2.transactions[0].apply).returns.toExtend<number>();
});Решение учителя откроется через:
20:00
