sindresorhus/type-fest

Jsonify makes Record<string, any> disappear

Open

#667 ouverte le 24 août 2023

Voir sur GitHub
 (7 commentaires) (0 réactions) (0 assignés)TypeScript (12 328 stars) (471 forks)batch import
enhancementhelp wanted

Description

Here's a TS Playground:

import type { Jsonify } from "type-fest";

type Data = Jsonify<{
  payload: Record<string, any>;
}>;

declare const d: Data;
console.log(d.payload) // <-- Property 'payload' does not exist on type 'JsonifyObject<{}>'.

This feels like a bug to me. It's causing an issue for me in the upcoming version of Remix: https://github.com/remix-run/remix/issues/7246

My current workaround is to change the type to unknown instead of any (https://github.com/edmundhung/conform/pull/272 which will hopefully be merged soon). I think is the proper thing to do, but sometimes that's hard because you may not control the type. I think it's more correct to keep the record around on the type.

Guide contributeur

Stack technique
typescript
Domaine
developer experience
Type d'issue
bug
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.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Basic TypeScriptUnderstanding of type fest
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
30
Direction de recherche
Investigate the Jsonify type implementation in the source (likely source/jsonify.ts). The issue demonstrates that Jsonify<Record<string, any>> resolves to an empty object. The root cause is likely in the handling of index signatures in mapped types. Consider how the type can preserve the Record shape. Also review the linked Remix issue for context. Add a test to cover this case.