Зробіть усі властивості в інтерфейсі Typescript необов’язковими


96

У моєму додатку є інтерфейс:

interface Asset {
  id: string;
  internal_id: string;
  usage: number;
}

це частина інтерфейсу повідомлення:

interface Post {
  asset: Asset;
}

У мене також є інтерфейс для чернетки, де об’єкт активу може бути побудований лише частково

interface PostDraft {
  asset: Asset;
}

Я хочу дозволити PostDraftоб'єкту мати частковий об'єкт активу, одночасно перевіряючи типи властивостей, які там є (тому я не хочу просто міняти його місцями any).

В основному я хочу, щоб спосіб міг генерувати наступне:

interface AssetDraft {
  id?: string;
  internal_id?: string;
  usage?: number;
}

без повного перевизначення Assetінтерфейсу. Чи є спосіб зробити це? Якщо ні, то яким би був розумний спосіб розташування моїх типів у цій ситуації?


Сьогодні вам потрібно зробити цей другий інтерфейс вручну, хоча це може змінитися найближчим часом: перевірте проблему з частковими типами в репозиторії ts, якщо ви зацікавлені.
— Alex Guerra

Відповіді:


208

Це неможливо в TypeScript <2.1 без створення додаткового інтерфейсу з необов’язковими властивостями; однак це можливо за допомогою зіставлених типів у TypeScript 2.1+.

Для цього використовуйте Partial<T>тип, який TypeScript надає за замовчуванням.

interface PostDraft {
    asset: Partial<Asset>;
}

Тепер усі властивості на assetє необов’язковими, що дозволить вам зробити наступне:

const postDraft: PostDraft = {
    asset: {
        id: "some-id"
    }
};

Про Partial<T>

Partial<T>буде визначено як відображений типу , що робить кожне властивість в умови типу факультативного ( з допомогою ?маркерів).

type Partial<T> = {
    [P in keyof T]?: T[P];
};

Детальніше про відображені типи читайте тут та у довіднику .


@david чи можна піти іншим шляхом? Щоб позначити поля, які раніше були частковими, як потрібно? А також чи можна це робити на основі поля?
— Тоні

1
@Tony так, це буде можливо з умовними типами в TS 2.8 (див. Required<T>).
— Девід Шеррет,

2
omg це таке чисте рішення. Шкода, що я знав це трохи раніше
— CiriousJoker

3
Продовжував дивуватись думці, яка увійшла в TS ... від Microsoft не менше. Бажаю, щоб така сама навмисність увійшла в їх розробку веб-браузера (-_-)
— більший Кінг

4

Властивості в інтерфейсі необов’язкові, ні, ви не можете використовувати один і той же інтерфейс один раз як необов’язковий і один раз як обов’язковий.

Що ви можете зробити, це мати інтерфейс з необов’язковими властивостями для, AssetDraftа потім клас із обов’язковими властивостями для Asset:

interface AssetDraft {
    id?: string;
    internal_id?: string;
    usage?: number;
}

class Asset {
    static DEFAULT_ID = "id";
    static DEFAULT_INTERNAL_ID = "internalid";
    static DEFAULT_USAGE = 0;

    id: string;
    internal_id: string;
    usage: number;

    constructor(draft: AssetDraft) {
        this.id = draft.id || Asset.DEFAULT_ID;
        this.internal_id = draft.internal_id || Asset.DEFAULT_INTERNAL_ID;
        this.usage = draft.usage || Asset.DEFAULT_USAGE;
    }
}

Тут значення за замовчуванням - статичні члени, але ви можете отримати їх іншими способами або вивести помилку, якщо вони відсутні.

Я вважаю цей спосіб дуже зручним при роботі з jsons, які отримуються від сервера (або чимось подібним), інтерфейси представляють дані json, а класи - це фактичні моделі, які будуються з використанням jsons як початкових значень.


Так, можна ... як зазначено у відповіді Девіда Шеррета ... вам потрібно було б використовувати загальну змінну типу для передачі вашого інтерфейсу як Partial <T> ..T, який є вашим інтерфейсом.
— більшийКороль

@greaterKing зараз це можливо і легко
— Nitzan Tomer

1

Якщо я хочу мати явний AssetDraftінтерфейс, я б використав комбінацію extendsта Partial:

interface Asset {
  id: string;
  internal_id: string;
  usage: number;
}

interface AssetDraft extends Partial<Asset> {}

0

Окрім Девіда Шеррета, відповідь лише на кілька рядків з мого боку, як це можна реалізувати безпосередньо без Partial<T>типу для кращого розуміння теми.

interface IAsset {
  id: string;
  internal_id: string;
  usage: number;
}

interface IPost {
  asset: IAsset;
}

interface IPostDraft {
  asset: { [K in keyof IAsset]?: IAsset[K] };
}

const postDraft: IPostDraft = {
  asset: {
    usage: 123
  }
};

-1

Як щодо сили кидати порожній об’єкт, наприклад

const draft = <PostDraft>{}
draft.id = 123
draft.internal_id = 456
draft.usage = 789

Якщо це вам дійсно потрібно, ви завжди можете створити інтерфейс d.ts із шаблону, який надає як необов’язкові, так і введені властивості.

Як зазначив Ніцан, властивості інтерфейсу Typescript є необов’язковими чи ні

Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.