Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #180 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 11 11
Lines 505 522 +17
Branches 54 58 +4
=========================================
+ Hits 505 522 +17 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a units option to three main functions (getExtremesPrediction, getTimelinePrediction, and getWaterLevelAtTime) allowing users to request water level predictions in feet instead of the default meters.
- Adds a
Unitstype andunitsparameter with 'meters' (default) and 'feet' options - Implements unit conversion using a
toPreferredUnitshelper function with a conversion factor of 3.2808399 feet per meter - Updates return types to include the
unitsfield in prediction results
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| packages/neaps/src/index.ts | Core implementation of the units option, including type definitions, conversion logic, and integration into all three prediction functions |
| packages/neaps/test/index.test.ts | Test coverage for the new units functionality across all prediction functions, including error handling for unsupported units |
| examples/units.ts | Example demonstrating how to use the units option to compare meters and feet predictions |
| README.md | Documentation updates showing the units parameter in all three function examples with output samples |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
The
levelvalue is returned in feet instead of meters.