elastic/kibana

[saved objects] Improve type safety in the saved objects repository

Open

#239,468 建立於 2025年10月17日

在 GitHub 查看
 (4 留言) (0 反應) (1 負責人)TypeScript (19,065 star) (8,021 fork)batch import
Feature:Saved ObjectsTeam:Coregood first issue💝community

描述

The is an existing pattern of using // @ts-expect-error MultiGetHit._source is optional comments in the saved object repository code that weakens the type safety. We should use a type guard instead

/**
 * Type guard to check if an item is a GetGetResult.
 */
export function isGetGetResult<TDocument = unknown>(
  item: MgetResponseItem<TDocument>
): item is GetGetResult<TDocument> {
  return (item as MgetMultiGetError).error === undefined;
}

Originally posted by @rudolf in https://github.com/elastic/kibana/pull/224411#discussion_r2348988329

貢獻者指南

技術棧
typescriptnodejs
領域
backend
議題類型
refactor
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
blocked
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Understanding of TypeScript genericsFamiliarity with saved objects repository codebase
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
55
研究方向
Review the discussion at https://github.com/elastic/kibana/pull/224411#discussion r2348988329 for the suggested type guard implementation. Then locate all `// @ts expect error` comments in the saved objects repository source files and replace them with the type guard function as described in the issue.
[saved objects] Improve type safety in the saved objects repository · elastic/kibana#239468 | Good First Issue