Typescript: Модификаторы сопоставления типов (Mapping Modifiers)
При сопоставлении типов можно менять атрибуты свойств такие как неизменность (immutability) и необязательность (optionality). Делается это с помощью соответствующих модификаторов: readonly и ?.
Чтобы добавить или удалить эти модификаторы, можно использовать префиксы + или -. Если не использовать префикс, то подразумевается что модификатор будет добавлен, то есть по умолчанию префикс +.
Примеры использования модификаторов есть в Utility Types:
/**
* Делает все свойства типа `T` необязательными,
* то есть добавляет атрибут `?`.
*/
type Partial<T> = {
[P in keyof T]?: T[P];
};
/**
* Делает все свойства типа `T` обязательными,
* то есть удаляет атрибут `?`.
*/
type Required<T> = {
[P in keyof T]-?: T[P];
};
/**
* Делает все свойства типа `T` неизменяемыми,
* то есть добавляет атрибут `readonly`.
*/
type Readonly<T> = {
readonly [P in keyof T]: T[P];
};
Подобным образом можно написать и тип, который делает все свойства типа изменяемыми, то есть удаляет атрибут readonly:
type Mutable<T> = {
-readonly [P in keyof T]: T[P];
};
Благодаря таким типам легче далеть производные типы из уже имеющихся.
Например, в приложении может быть тип User для не авторизованного пользователя у которого все поля не обязательные:
type User = {
id?: string;
firstName?: string;
secondName?: string;
email?: string;
};
Из него можно сделать авторизованного пользователя с помощью типа Required:
type AuthorizedUser = Required<DefaultUser>;
Задание
Реализуйте функцию deepFreeze(), которая принимает на вход объект и делает его самого, его поля и все вложенные объекты неизменяемыми и возвращает этот объект.
Предполагается что поля объекта и поля вложенных объектов не содержат массивы, только простые типы данных и объекты.
const user = deepFreeze({
name: 'John',
password: '1q2w3e',
token: 'test',
});
user.name = 'Alex'; // Error: Cannot assign to 'name' because it is a read-only property.
Нужно использовать встроенный в JavaScript метод Object.freeze().
Полезное
Упражнение не проходит проверку — что делать? 😶
Если вы зашли в тупик, то самое время задать вопрос в «Обсуждениях». Как правильно задать вопрос:
- Обязательно приложите вывод тестов, без него практически невозможно понять что не так, даже если вы покажете свой код. Программисты плохо исполняют код в голове, но по полученной ошибке почти всегда понятно, куда смотреть.
В моей среде код работает, а здесь нет 🤨
Тесты устроены таким образом, что они проверяют решение разными способами и на разных данных. Часто решение работает с одними входными данными, но не работает с другими. Чтобы разобраться с этим моментом, изучите вкладку «Тесты» и внимательно посмотрите на вывод ошибок, в котором есть подсказки.
Мой код отличается от решения учителя 🤔
Это нормально 🙆, в программировании одну задачу можно выполнить множеством способов. Если ваш код прошел проверку, то он соответствует условиям задачи.
В редких случаях бывает, что решение подогнано под тесты, но это видно сразу.
Прочитал урок — ничего не понятно 🙄
Создавать обучающие материалы, понятные для всех без исключения, довольно сложно. Мы очень стараемся, но всегда есть что улучшать. Если вы встретили материал, который вам непонятен, опишите проблему в «Обсуждениях». Идеально, если вы сформулируете непонятные моменты в виде вопросов. Обычно нам нужно несколько дней для внесения правок.
Кстати, вы тоже можете участвовать в улучшении курсов: внизу есть ссылка на исходный код уроков, который можно править прямо из браузера.
Ваше упражнение проверяется по этим тестам
1import * as ta from 'type-assertions';
2
3import deepFreeze from './index';
4
5test('deepFreeze', () => {
6 const obj = {
7 name: 'John',
8 age: 30,
9 location: {
10 city: 'York',
11 coordinates: {
12 lat: 53.958,
13 lon: -1.093,
14 },
15 },
16 };
17
18 const user = deepFreeze(obj);
19
20 expect(user).toEqual({
21 name: 'John',
22 age: 30,
23 location: {
24 city: 'York',
25 coordinates: {
26 lat: 53.958,
27 lon: -1.093,
28 },
29 },
30 });
31
32 expect(() => {
33 // @ts-expect-error Cannot assign read-only property.
34 user.age = 20;
35 }).toThrow();
36
37 expect(() => {
38 // @ts-expect-error Cannot assign nested read-only property.
39 user.location.city = 'London';
40 }).toThrow();
41
42 ta.assert<ta.Equal<typeof user, Readonly<{
43 name: string,
44 age: number,
45 location: Readonly<{
46 city: string,
47 coordinates: Readonly<{
48 lat: number,
49 lon: number,
50 }>,
51 }>,
52 }>>>();
53});
54Решение учителя откроется через:
