code-chronicles-code/leetcode-curriculum

Add tests for `numericIdZodType` utility

Open

#334 opened on Aug 17, 2024

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)TypeScript (12 forks)auto 404
good first issuetests

Repository metrics

Stars
 (19 stars)
PR merge metrics
 (PR metrics pending)

Description

Zod is a library for validating and parsing data. numericIdZodType is a utility we use to validate and parse numeric IDs, it accepts positive integers or the string representation of a positive integer.

This issue involves adding a file workspaces/util/src/__tests__/numericIdZodType-test.ts, for testing the numericIdZodType utility. Specifically, we care about testing the parse function, so stuff like:

expect(numericIdZodType.parse(123)).toBe(123);
expect(() => numericIdZodType.parse(-123)).toThrow(/* some error */);

To see some PRs that add tests, take a look at #288 and #290 for inspiration.

Contributor guide

Research direction
Examine the existing test patterns in pull requests #288 and #290, then write test cases for valid and invalid inputs of numericIdZodType.parse.
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.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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
GitTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90