elastic/kibana

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

Open

#239 468 ouverte le 17 oct. 2025

Voir sur GitHub
 (4 commentaires) (0 réactions) (1 assigné)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

Guide contributeur

Stack technique
typescriptnodejs
Domaine
backend
Type d'issue
refactor
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
blocked
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Understanding of TypeScript genericsFamiliarity with saved objects repository codebase
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
55
Direction de recherche
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.