Skip to content

Commit e97c8ee

Browse files
committed
docs(lib): clarify requireDuration max cannot exceed 24h ceiling
Address CodeRabbit review nitpick: the opts.max docstring now explicitly states that it can only tighten, never loosen, the hard-coded 24-hour ceiling enforced by parseDuration.
1 parent 08d732b commit e97c8ee

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

src/lib/duration.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -178,8 +178,9 @@ export function formatDuration(ms: number): string {
178178
* @param input Raw duration string.
179179
* @param field Flag/field name for error messages.
180180
* @param opts.min Minimum duration in milliseconds (inclusive).
181-
* @param opts.max Maximum duration in milliseconds (inclusive).
182-
* Defaults to 24 hours.
181+
* @param opts.max Maximum duration in milliseconds (inclusive), capped at
182+
* and never able to exceed the 24-hour ceiling enforced by
183+
* `parseDuration`. Defaults to 24 hours when omitted.
183184
*/
184185
export function requireDuration(
185186
input: string,

0 commit comments

Comments
 (0)