ppetru/opensprinkler-weather
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document that AdjustmentOptions are non-nullable

Browse Source
This commit is contained in:
Matthew Oslan
2019-06-27 22:58:33 -04:00
parent 7e2d3458fd
commit 95dadf601d
3 changed files with 14 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
routes/adjustmentMethods/AdjustmentMethod.ts
View File

@@ -5,9 +5,8 @@ import { WeatherProvider } from "../weatherProviders/WeatherProvider";
export interface AdjustmentMethod {
/**
* Calculates the percentage that should be used to scale watering time.
* @param adjustmentOptions The user-specified options for the calculation, or undefined/null if no custom values
* are to be used. No checks will be made to ensure the AdjustmentOptions are the correct type that the function
* is expecting or to ensure that any of its fields are valid.
* @param adjustmentOptions The user-specified options for the calculation. No checks will be made to ensure the
* AdjustmentOptions are the correct type that the function is expecting or to ensure that any of its fields are valid.
* @param wateringData The basic weather information of the watering site. This may be undefined if an error occurred
* while retrieving the data.
* @param coordinates The coordinates of the watering site.