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 (12,328 stars) (471 forks)batch import
help wanted

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

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.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic TypeScripttype system fundamentals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Examine the existing test file at test d/readonly deep.ts to understand the test pattern. Review the ReadonlyDeep type definition at source/readonly deep.d.ts to determine how it handles function return types. The goal is to add a test case for `ReadonlyDeep<() => Map>` and verify the expected behavior by checking if the result is a Map or ReadonlyDeep<Map>. Refer to existing tests for structure and assertions.