sindresorhus/type-fest

Jsonify makes Record<string, any> disappear

Open

#667 opened on Aug 24, 2023

View on GitHub
 (7 comments) (0 reactions) (0 assignees)TypeScript (471 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (12,328 stars)
PR merge metrics
 (Avg merge 3d 5h) (11 merged PRs in 30d)

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.

Contributor guide

Research direction
Examine the Jsonify type implementation in source/utilities.ts and trace how it processes Record<string, any>. Focus on the conditional type that might collapse the record into an empty object because `any` is being simplified. Check the test suite for similar cases.
Tech stack
typescript
Domain
tooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75