TS - Readonly, Required, Partial

2-minute read
Development
typescript • utility types

Сопоставимый тип Readonly Link to heading

Просто делает все поля объекта как readonly:

interface Bulochka {
    price: number;
    weight: number;
    lenght: number;
    brand: string;
}

const bulochka: Readonly<Bulochka> = {
    price: 12,
    weight: 200,
    lenght: 100,
    brand: 'white'
}

… в данном случае все поля объекта bulochka будут доступны только для чтения:

const bulochka = {
    readonly price: number;
    readonly weight: number;
    readonly lenght: number;
    readonly brand: string;
}

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

/**
 * Надежная функция, защищающая свои
 * параметры от изменения, не требуя описания
 * нового неизменяемого типа.
 */
function immutableAction(person: Readonly<IPerson>) {
  person.name = 'NewName'; // Error -> Cannot assign to 'name' because it is a read-only property.
}

Примеры из реальной практики Link to heading 

private filterGroups(groups: Readonly<IFaqGroup[]>, filter: Readonly<IFaqFilter>): IFaqGroup[] {
    let result: IFaqGroup[] = [...groups];

    if (filter.group) {
        result = result.filter(group => group.id === filter.group);
    }

    if (filter.search) {
        result = result.filter(group => group.name.includes(filter.search)
            || new FaqQuestionsFilterPipe().transform(group.questions, filter).length > 0);
    }

    return result;
}

Сопоставимый тип Required Link to heading

… просто делает все поля объекта обязательными; такой пример:

interface Bulochka {
    price?: number;
    weight?: number;
    lenght?: number;
    brand?: string;
}

const readonlyBulochka: Required<Bulochka> = {
    price: 12,
    weight: 200,
    lenght: 100,
};

… будет с ошибкой, так как не задано обязательное поле brand:

Property 'brand' is missing in type '{ price: number; weight: number; lenght: number; }' but required in type 'Required<Bulochka>'.

Сопоставимый тип Partial Link to heading

Противоположность Required - делает поля объекта не обязательными, добавляет членам объекта модификатор ?. Такой пример ошибкой не будет:

interface Bulochka {
    price: number;
    weight: number;
    lenght: number;
    brand: string;
}

const readonlyBulochka: Partial<Bulochka> = {
    price: 12,
    weight: 200,
    lenght: 100,
};

Примеры из реальной практики Link to heading 

@Pipe({
    name: 'addAllSelectionViewAsAccount'
})
export class AddAllSelectionViewAsAccountPipe implements PipeTransform {
    transform(accounts: Account[]): Partial<Account>[] {
        return [{ id: ALL_SELECTOR.id, displayedName: ALL_SELECTOR.name }, ...accounts];
    }
}

private checkBaseConfigParameters(_cfg: Partial<IConfig>): void {
    if (!_cfg.basePath) {
        throw new BaseConfigParameterError('Адрес сервера');
    }

    if (!_cfg.customer) {
        throw new BaseConfigParameterError('Контрагент');
    }
}

private static readonly _templateFileName: Partial<Record<IndicationType, string>> = {
    [IndicationType.interval]: 'Интервальные показания',
    [IndicationType.integral]: 'Интегральные показания',
    [IndicationType.meteringPointConsumption]: 'Расход ТУ'
};