Repository navigation
docs: say what a pattern means when the clock changes - #25
Merged
Merged
Conversation
Three places a reader meets a surprise and the README was silent: that an availability pattern names wall-clock times, so a shift is eight hours on the clock and seven or nine elapsed on a transition day; that a daily window is measured on the caller's day, so an evening window crossing UTC midnight keeps its slots; and that busy times are now validated and copied on the way in, so a bad Date throws rather than being scheduled against. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Three one-liners in the README, each where a reader meets a surprise the docs were silent about.
Weekly Availability — a pattern names times on your clock, not instants.
09:00–17:00is eight hours on the clock every week, which is seven or nine elapsed hours on the two days a year the zone changes offset, the same thing a recurring block does in Google Calendar or Outlook. A wall time the clock skips is not offered; one it repeats is offered twice.Daily windows — the window is measured on the caller's local day, so an evening window crossing UTC midnight (
20:00–24:00in New York) keeps its slots. That one used to be false: those slots were dropped.Managing busy times — validation now throws on an unparseable or inverted interval, and the Dates are copied, so mutating your input or
getBusyTimes()output no longer changes the answers.Documents behaviour shipped in #24; no code changes.
package.jsonstays at 0.7.1, which is still ahead of npm's 0.7.0.🤖 Generated with Claude Code