Как типизировать данные приходящие по api в Typescript?

Question

[ForsakenHedgehog]

Не понимаю типизацию в некоторых случаях.

Есть node_telegram_bot_api, на нём решил потренироваться с typescript (ранее с типизированными языками работал совсем немного, только всякие задачки на учёбе решаем на с++).

Когда я сам создаю переменные или объекты/массивы - я знаю какой у них должен быть тип данных.
Когда использую данные, которые приходят из вне - впадаю в ступор.
Места ступора в комментариях внутри кода:

const TelegramBot = require('node_telegram_bot_api');

const bot: /*  нужно ли обозначать тип в данном случае? */ = new TelegramBot(TOKEN, {  
    polling: true
})

bot.on("message", (msg: /* Сюда приходит объект с разной глубиной вложенности данных.
Тип object с пречислением всех возможных данных { ... } - не кажется правильным, хотя я может быть и ошибаюсь*/) => {
    bot.sendMessage(msg.chat.id, "Hello world")!
})

Answer 1

[RidgeA]

можно описать интерфейс и указать что msg соответствует определенному интерфейсу

Comments

[ForsakenHedgehog]

Так и предполагал, что это делается помощью интерфейсов - надо скорее изучать как они работают.
Но про вложенность всё-равно не понятно:

Вот например получаю такой json. Как его можно описать?
В интернете нагугливаются примеры с описанием интерфейсов с одноуровневой вложенностью, что с реальностью не всегда соотносится.

{
"id": 1,
"name": "Leanne Graham",
"username": "Bret",
"address":   {
"street": "Kulas Light",
"geo": {
"lat": "-37.3159",
"lng": "81.1496"
}
},
"phone": "1-770-736-8031 x56442",
"website": "hildegard.org",
"company": {
"name": "Romaguera-Crona",
"catchPhrase": "Multi-layered client-server neural-net",
"bs": "harness real-time e-markets"
}
},

[Алексей Ярков]

ForsakenHedgehog,

{
  "id": 1,
  "name": "Leanne Graham",
  "username": "Bret",
  "address": {
    "street": "Kulas Light",
    "geo": {
      "lat": "-37.3159",
      "lng": "81.1496"
    }
  },
  "phone": "1-770-736-8031 x56442",
  "website": "hildegard.org",
  "company": {
    "name": "Romaguera-Crona",
    "catchPhrase": "Multi-layered client-server neural-net",
    "bs": "harness real-time e-markets"
  }
}

interface RootObject {
  id: number;
  name: string;
  username: string;
  address: Address;
  phone: string;
  website: string;
  company: Company;
}

interface Company {
  name: string;
  catchPhrase: string;
  bs: string;
}

interface Address {
  street: string;
  geo: Geo;
}

interface Geo {
  lat: string;
  lng: string;
}

Можете пройти на json2ts.com и попробовать что получится. Для VSCode есть плагин для этого. Очень удобно.

[ForsakenHedgehog]

Алексей Ярков, большое спасибо, это супер наглядно!

Answer 2

[abberati]

Если верите апишке – можете описать сколько угодно вложенную структуру данных. Из вашего комментария:

type User = {
  id: number
  name: string
  username: string
  address: {
    street: string
    geo: {
      lat: string
      lng: string
    }
  }
  phone: string
  website: string
  company: {
    name: string
    catchPhrase: string
    bs: string
  }
}

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

type Adress = {
  street: string
  geo: {
    lat: string
    lng: string
  }
}

type Company = {
  name: string
  catchPhrase: string
  bs: string
}

type User = {
  id: number
  name: string
  username: string
  address: Adress
  phone: string
  website: string
  company: Company
}

Если апишке не доверяете, посмотрите в сторону yup. Он позволяет описать схему валидации, после прохождения которой любые неизвестные данные либо приводятся к необходимому типу, либо валидация падает с ошибкой (которую можно обработать и что-то с ошибкой сделать)

Comments

[ForsakenHedgehog]

Прекрасно дополнили первый ответ. Благодарю :)