Как заставить typescript поверить, что в объекте есть свойство?

Question

[Антон Антон]

Перевожу прооект на typescript, параллельно разбираясь с этим самым typescript'ом
Есть вот такой кусок кода:

export async function create (path: string, data: object) {
  return (await api.post(`${path}`, data)).data.data
}

export async function update (path: string, data: { id: number | string }) {
  return (await api.put(`${path}/${data.id}`, data)).data.data
}

export async function upsert (path: string, data: { id?: number | string }) {
  if (Object.hasOwn(data, 'id')) { // тут пробовал разные проверки наличия свойства у объекта
    return await update(path, { ...data, id: data.id ?? '' }) // но никакая проверка не помогает, пришлось подставить костыль
  } else {
    return await create(path, data)
  }
}

как заставить поверить typescript что свойство есть, чтобы убрать костыль и передавать просто data?

Comments

[WbICHA]

как заставить поверить typescript что свойство есть

Так он и не спорит, что оно есть, просто ты делаешь не ту проверку.

if (typeof data.id !== undefined) {

Answer 1

[modelair]

есть такая штука - typeguard. он сообщает ts'у, что этот объект определенного типа, который указан после is. вот простенький, дальше разберешься, думаю.

function isData(data: any): data is { id: number | string } {
  return data.id !== undefined
}

Comments

[Антон Антон]

Спасибо! Выглядит как костыль, но пусть будет так. И заинлайнить нельзя (

[modelair]

Антон Антон, не, это обычный guard, типичный инструмент. точно так же работает, к примеру, Array.isArray.
заинлайнить? а как ты хотел сделать

[Антон Антон]

modelair, if (Object.hasOwn(data, 'id'): data is { id: number | string })

[modelair]

Антон Антон,

export async function upsert (path: string, data: unknown) {
    return await (isData(data) ? update(path, data) : create(path, data))
}

всё ж просто.

[modelair]

Антон Антон, за true ts уже знает, что там полюбому есть поле id, а в create соответственно приходит unknown или какой там может быть еще, на твой выбор

[Антон Антон]

modelair, да не, я про то, чтобы не делать функцию isData отдельной функцией, а приписать data is { id: number | string } к условию в if.

[modelair]

Антон Антон, ну, всё таки ts он не в рантайме :) поэтому налегке так проверить нельзя. типов не существует в компилированном коде. typeguard дает тебе стопроцентную гарантию соответствия

[Антон Антон]

modelair, 10 лет пожеланию: https://github.com/Microsoft/TypeScript/issues/3744 ))

[modelair]

Антон Антон, я когда начинал изучать ts, у меня местами рвало пукан. данная ишью - фантазии неподготовленного узера)
вот че они хотели от

function drawGeometry(shape) {
    if(shape is Point2D) { ... }
    if(shape is Point3D) { ... }
    if(shape is Line) { ... }
}

таким образом никак не отличить один интерфейс от другого средствами javascript, здесь только функции. если делать это сахаром, то как понять, что именно сахар делает? куда идти-то.

[Антон Антон]

modelair, но я-то хочу то, что решается именно гвардами. просто заинлайненными. например с jsdoc/phpdoc можно написать комментарий: здесь мы считаем эту переменную такого типа. и все будет работать. Почему бы тут не сделать синтаксис для такого инлайна? типа

export async function upsert (path: string, data: Type1|Type2 ) {
  if ((data.id !== undefined): data is Type1) {
    return await update(path, data)
  } else (data is Type2) {
    return await create(path, data)
  }
}

[modelair]

Антон Антон, а ну, если так посмотреть, то это простой as. но as это небезопасно.
ты можешь сразу сделать let data = somedata as DataType и ts перестанет ругаться. но а так, по сути, при должной проверке это - то же самое. просто гарды надежней и удобней. гард расскажет всей области видимости, что data is {id: string}, а с as надо в каждом месте приводить или делать const _data: {id: string} = data as {id: string}. as редко используется в коде, оно не то что бы моветон, но нежелательно

export async function upsert (path: string, data: { id?: number | string } ) {
  if (data.id !== undefined) {
    return await update(path, data as { id: string } )
  } else {
    return await create(path, data)
  }
}