Skip to content

Commit

Permalink
chore(core): clarify support for ISO duration (aws#29576)
Browse files Browse the repository at this point in the history
Closes aws#29572.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
msambol authored and jun1-t committed Mar 23, 2024
1 parent e331d01 commit 5917b65
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions packages/aws-cdk-lib/core/lib/duration.ts
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,13 @@ export class Duration {
/**
* Parse a period formatted according to the ISO 8601 standard
*
* Days are the largest ISO duration supported, i.e.,
* weeks, months, and years are not supported.
*
* @example
* // This represents 1 day, 2 hours, 3 minutes, 4 seconds, and 567 milliseconds.
* 'P1DT2H3M4.567S'
*
* @see https://www.iso.org/standard/70907.html
* @param duration an ISO-formatted duration to be parsed.
* @returns the parsed `Duration`.
Expand Down

0 comments on commit 5917b65

Please sign in to comment.