elastic/kibana

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

Open

#239468 opened on Oct 17, 2025

View on GitHub
 (4 comments) (0 reactions) (1 assignee)TypeScript (19,065 stars) (8,021 forks)batch import
Feature:Saved ObjectsTeam:Coregood first issue💝community

Description

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

Contributor guide

Tech stack
typescriptnodejs
Domain
backend
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Understanding of TypeScript genericsFamiliarity with saved objects repository codebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55
Research direction
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.