kelektiv/node-cron

refactor runtime check & typings of exclusive parameters timeZone & utcOffset

Open

#704 opened on Sep 30, 2023

View on GitHub
 (3 comments) (1 reaction) (0 assignees)JavaScript (7,868 stars) (650 forks)batch import
good first issuehacktoberfesthelp wantedstatus:readytype:refactor

Description

Does it? First condition precludes the second

https://github.com/kelektiv/node-cron/blob/a7dee32091b91dcf465e67c32a57d66151b5a774/src/job.ts#L56 https://github.com/kelektiv/node-cron/blob/a7dee32091b91dcf465e67c32a57d66151b5a774/src/job.ts#L57

https://github.com/kelektiv/node-cron/blob/a7dee32091b91dcf465e67c32a57d66151b5a774/src/job.ts#L65

Contributor guide

Tech stack
typescript
Domain
backend
Issue type
refactor
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.
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.
mostly clear
Prerequisites
TypeScript basicsUnderstanding of cron
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Review src/job.ts lines 56-57 and 65 in the node cron repository. The condition on line 56 (`if (timeZone)`) makes the subsequent check on line 57 (`if (utcOffset)`) unreachable when both are exclusive. Examine the TypeScript type definitions to ensure they correctly enforce exclusivity. No linked pull requests or comments indicate a resolution, so the approach is to refactor the runtime logic and update typings accordingly.