sindresorhus/type-fest

ReadonlyDeep: add test for function or method returning an object?

Open

#826 opened on Mar 7, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (471 forks)batch import
help wanted

Repository metrics

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

Description

Reading through the ReadonlyDeep type and its tests, I can't tell if ReadonlyDeep<() => Map>() would return a Map or a ReadonlyDeep<Map>. The tests just don't cover that sort of case.

Contributor guide

Research direction
Examine the existing ReadonlyDeep tests to understand how they test function return types, then write a test for a function returning a Map or similar object to verify whether the result is deeply readonly.
Tech stack
typescript
Domain
testing
Issue type
Test
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.
70