Освоение служебных типов TypeScript: практическое руководство для глобальных разработчиков

TypeScript предлагает мощный набор встроенных служебных типов, которые могут значительно повысить безопасность, читаемость и удобство сопровождения вашего кода. Эти служебные типы, по сути, являются предопределенными преобразованиями типов, которые можно применять к существующим типам, избавляя вас от написания повторяющегося и подверженного ошибкам кода. В этом руководстве будут рассмотрены различные служебные типы с практическими примерами, которые будут интересны разработчикам по всему миру.

Зачем использовать служебные типы?

Служебные типы решают распространенные сценарии манипулирования типами. Используя их, вы можете:

• Сократить шаблонный код: Избегайте написания повторяющихся определений типов.
• Повысить безопасность типов: Убедитесь, что ваш код соответствует ограничениям типов.
• Улучшить читаемость кода: Сделайте определения типов более краткими и легкими для понимания.
• Повысить удобство сопровождения: Упростите изменения и снизьте риск внесения ошибок.

Основные служебные типы

Partial

Partial создает тип, в котором все свойства T установлены как необязательные. Это особенно полезно, когда вы хотите создать тип для частичных обновлений или объектов конфигурации.

Пример:

Представьте, что вы создаете платформу электронной коммерции с клиентами из разных регионов. У вас есть тип Customer:

interface Customer {
  id: string;
  firstName: string;
  lastName: string;
  email: string;
  phoneNumber: string;
  address: {
    street: string;
    city: string;
    country: string;
    postalCode: string;
  };
  preferences?: {
    language: string;
    currency: string;
  }
}

При обновлении информации о клиенте вам может не потребоваться указание всех полей. Partial позволяет определить тип, в котором все свойства Customer являются необязательными:

type PartialCustomer = Partial<Customer>;

function updateCustomer(id: string, updates: PartialCustomer): void {
  // ... реализация для обновления клиента с заданным ID
}

updateCustomer("123", { firstName: "John", lastName: "Doe" }); // Valid
updateCustomer("456", { address: { city: "London" } }); // Valid

Readonly

Readonly создает тип, в котором все свойства T установлены как readonly, предотвращая изменение после инициализации. Это ценно для обеспечения неизменяемости.

Пример:

Рассмотрим объект конфигурации для вашего глобального приложения:

interface AppConfig {
  apiUrl: string;
  theme: string;
  supportedLanguages: string[];
  version: string; // Added version
}

const config: AppConfig = {
  apiUrl: "https://api.example.com",
  theme: "dark",
  supportedLanguages: ["en", "fr", "de", "es", "zh"],
  version: "1.0.0"
};

Чтобы предотвратить случайное изменение конфигурации после инициализации, можно использовать Readonly:

type ReadonlyAppConfig = Readonly<AppConfig>;

const readonlyConfig: ReadonlyAppConfig = {
  apiUrl: "https://api.example.com",
  theme: "dark",
  supportedLanguages: ["en", "fr", "de", "es", "zh"],
  version: "1.0.0"
};

// readonlyConfig.apiUrl = "https://newapi.example.com"; // Error: Cannot assign to 'apiUrl' because it is a read-only property.

Pick

Pick создает тип, выбирая набор свойств K из T, где K является объединением строковых литеральных типов, представляющих имена свойств, которые вы хотите включить.

Пример:

Предположим, у вас есть интерфейс Event с различными свойствами:

interface Event {
  id: string;
  title: string;
  description: string;
  location: string;
  startTime: Date;
  endTime: Date;
  organizer: string;
  attendees: string[];
}

Если вам нужны только title, location и startTime для конкретного компонента отображения, вы можете использовать Pick:

type EventSummary = Pick<Event, "title" | "location" | "startTime">;

function displayEventSummary(event: EventSummary): void {
  console.log(`Event: ${event.title} at ${event.location} on ${event.startTime}`);
}

Omit

Omit создает тип, исключая набор свойств K из T, где K является объединением строковых литеральных типов, представляющих имена свойств, которые вы хотите исключить. Это противоположность Pick.

Пример:

Используя тот же интерфейс Event, если вы хотите создать тип для создания новых событий, вы можете исключить свойство id, которое обычно генерируется сервером:

type NewEvent = Omit<Event, "id">;

function createEvent(event: NewEvent): void {
  // ... реализация для создания нового события
}

Record

Record создает тип объекта, ключи свойств которого K, а значения свойств которого T. K может быть объединением строковых литеральных типов, числовых литеральных типов или символов. Это идеально подходит для создания словарей или карт.

Пример:

Представьте, что вам нужно хранить переводы для пользовательского интерфейса вашего приложения. Вы можете использовать Record, чтобы определить тип для ваших переводов:

type Translations = Record<string, string>;

const enTranslations: Translations = {
  "hello": "Hello",
  "goodbye": "Goodbye",
  "welcome": "Welcome to our platform!"
};

const frTranslations: Translations = {
  "hello": "Bonjour",
  "goodbye": "Au revoir",
  "welcome": "Bienvenue sur notre plateforme !"
};

function translate(key: string, language: string): string {
  const translations = language === "en" ? enTranslations : frTranslations; //Simplified
  return translations[key] || key; // Fallback to the key if no translation is found
}

console.log(translate("hello", "en")); // Output: Hello
console.log(translate("hello", "fr")); // Output: Bonjour
console.log(translate("nonexistent", "en")); // Output: nonexistent

Exclude

Exclude создает тип, исключая из T все члены объединения, которые могут быть присвоены U. Это полезно для фильтрации определенных типов из объединения.

Пример:

У вас может быть тип, представляющий различные типы событий:

type EventType = "concert" | "conference" | "workshop" | "webinar";

Если вы хотите создать тип, который исключает события "webinar", вы можете использовать Exclude:

type PhysicalEvent = Exclude<EventType, "webinar">;

// PhysicalEvent is now "concert" | "conference" | "workshop"

function attendPhysicalEvent(event: PhysicalEvent): void {
  console.log(`Attending a ${event}`);
}

// attendPhysicalEvent("webinar"); // Error: Argument of type '"webinar"' is not assignable to parameter of type '"concert" | "conference" | "workshop"'.

attendPhysicalEvent("concert"); // Valid

Extract

Extract создает тип, извлекая из T все члены объединения, которые могут быть присвоены U. Это противоположность Exclude.

Пример:

Используя тот же EventType, вы можете извлечь тип события webinar:

type OnlineEvent = Extract<EventType, "webinar">;

// OnlineEvent is now "webinar"

function attendOnlineEvent(event: OnlineEvent): void {
  console.log(`Attending a ${event} online`);
}

attendOnlineEvent("webinar"); // Valid
// attendOnlineEvent("concert"); // Error: Argument of type '"concert"' is not assignable to parameter of type '"webinar"'.

NonNullable

NonNullable создает тип, исключая null и undefined из T.

Пример:

type MaybeString = string | null | undefined;

type DefinitelyString = NonNullable<MaybeString>;

// DefinitelyString is now string

function processString(str: DefinitelyString): void {
  console.log(str.toUpperCase());
}

// processString(null); // Error: Argument of type 'null' is not assignable to parameter of type 'string'.
// processString(undefined); // Error: Argument of type 'undefined' is not assignable to parameter of type 'string'.
processString("hello"); // Valid

ReturnType

ReturnType создает тип, состоящий из возвращаемого типа функции T.

Пример:

function greet(name: string): string {
  return `Hello, ${name}!`;
}

type Greeting = ReturnType<typeof greet>;

// Greeting is now string

const message: Greeting = greet("World");

console.log(message);

Parameters

Parameters создает тип кортежа из типов параметров функционального типа T.

Пример:

function logEvent(eventName: string, eventData: object): void {
  console.log(`Event: ${eventName}`, eventData);
}

type LogEventParams = Parameters<typeof logEvent>;

// LogEventParams is now [eventName: string, eventData: object]

const params: LogEventParams = ["user_login", { userId: "123", timestamp: Date.now() }];

logEvent(...params);

ConstructorParameters

ConstructorParameters создает тип кортежа или массива из типов параметров типа функции-конструктора T. Он выводит типы аргументов, которые необходимо передать конструктору класса.

Пример:

class Greeter {
  greeting: string;

  constructor(message: string) {
    this.greeting = message;
  }

  greet() {
    return "Hello, " + this.greeting;
  }
}


type GreeterParams = ConstructorParameters<typeof Greeter>;

// GreeterParams is now [message: string]

const paramsGreeter: GreeterParams = ["World"];
const greeterInstance = new Greeter(...paramsGreeter);

console.log(greeterInstance.greet()); // Outputs: Hello, World

Required

Required создает тип, состоящий из всех свойств T, установленных как обязательные. Делает все необязательные свойства обязательными.

Пример:

interface UserProfile {
  name: string;
  age?: number;
  email?: string;
}

type RequiredUserProfile = Required<UserProfile>;

// RequiredUserProfile is now { name: string; age: number; email: string; }

const completeProfile: RequiredUserProfile = {
  name: "Alice",
  age: 30,
  email: "alice@example.com"
};

// const incompleteProfile: RequiredUserProfile = { name: "Bob" }; // Error: Property 'age' is missing in type '{ name: string; }' but required in type 'Required'.

Расширенные служебные типы

Типы литеральных шаблонов

Типы литеральных шаблонов позволяют создавать новые строковые литеральные типы путем объединения существующих строковых литеральных типов, числовых литеральных типов и т. д. Это обеспечивает мощное манипулирование типами на основе строк.

Пример:

type HTTPMethod = "GET" | "POST" | "PUT" | "DELETE";
type APIEndpoint = `/api/users` | `/api/products`;

type RequestURL = `${HTTPMethod} ${APIEndpoint}`;

// RequestURL is now "GET /api/users" | "POST /api/users" | "PUT /api/users" | "DELETE /api/users" | "GET /api/products" | "POST /api/products" | "PUT /api/products" | "DELETE /api/products"

function makeRequest(url: RequestURL): void {
  console.log(`Making request to ${url}`);
}

makeRequest("GET /api/users"); // Valid
// makeRequest("INVALID /api/users"); // Error

Условные типы

Условные типы позволяют определять типы, которые зависят от условия, выраженного в виде отношения типов. Они используют ключевое слово infer для извлечения информации о типе.

Пример:

type UnwrapPromise<T> = T extends Promise<infer U> ? U : T;

// If T is a Promise, then the type is U; otherwise, the type is T.

async function fetchData(): Promise<number> {
  return 42;
}


type Data = UnwrapPromise<ReturnType<typeof fetchData>>;

// Data is now number

function processData(data: Data): void {
  console.log(data * 2);
}

processData(await fetchData());

interface FormData {
  firstName: string;
  lastName: string;
  email: string;
  country: string; // Required
  city?: string; // Optional
  postalCode?: string;
  newsletterSubscription?: boolean;
}

// Initial form values (optional fields)
type InitialFormValues = Partial<FormData>;

// Updated form values (some fields might be missing)
type UpdatedFormValues = Partial<FormData>;

// Required fields for submission
type RequiredForSubmission = Required<Pick<FormData, 'firstName' | 'lastName' | 'email' | 'country'>>;

// Use these types in your form components
function initializeForm(initialValues: InitialFormValues): void { }
function updateForm(updates: UpdatedFormValues): void {}
function submitForm(data: RequiredForSubmission): void {}


const initialForm: InitialFormValues = { newsletterSubscription: true };

const updateFormValues: UpdatedFormValues = {
    firstName: "John",
    lastName: "Doe"
};

// const submissionData: RequiredForSubmission = { firstName: "test", lastName: "test", email: "test" }; // ERROR: Missing 'country' 
const submissionData: RequiredForSubmission = { firstName: "test", lastName: "test", email: "test", country: "USA" }; //OK

interface APIResponse {
  user_id: string;
  first_name: string;
  last_name: string;
  email_address: string;
  profile_picture_url: string;
  is_active: boolean;
}

// Transform the API response to a more readable format
type UserData = {
  id: string;
  fullName: string;
  email: string;
  avatar: string;
  active: boolean;
};

function transformApiResponse(response: APIResponse): UserData {
  return {
    id: response.user_id,
    fullName: `${response.first_name} ${response.last_name}`,
    email: response.email_address,
    avatar: response.profile_picture_url,
    active: response.is_active
  };
}

function fetchAndTransformData(url: string): Promise<UserData> {
    return fetch(url)
        .then(response => response.json())
        .then(data => transformApiResponse(data));
}


// You can even enforce the type by:

function saferTransformApiResponse(response: APIResponse): UserData {
    const {user_id, first_name, last_name, email_address, profile_picture_url, is_active} = response;
    const transformed: UserData = {
        id: user_id,
        fullName: `${first_name} ${last_name}`,
        email: email_address,
        avatar: profile_picture_url,
        active: is_active
    };

    return transformed;
}

interface AppSettings {
  theme: "light" | "dark";
  language: string;
  notificationsEnabled: boolean;
  apiUrl?: string; // Optional API URL for different environments
  timeout?: number;  //Optional
}

// Default settings
const defaultSettings: AppSettings = {
  theme: "light",
  language: "en",
  notificationsEnabled: true
};

// Function to merge user settings with default settings
function mergeSettings(userSettings: Partial<AppSettings>): AppSettings {
  return { ...defaultSettings, ...userSettings };
}

// Use the merged settings in your application
const mergedSettings = mergeSettings({ theme: "dark", apiUrl: "https://customapi.example.com" });
console.log(mergedSettings);