Skip to content

Commit

Permalink
fix(docs): clarify that "trunc" will be the new rounding mode
Browse files Browse the repository at this point in the history
  • Loading branch information
brawaru committed Oct 13, 2023
1 parent 14bd123 commit eba537b
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ Describes a value within the time range that can be used as or converted to a ti
- `halfTrunc` — round values below or at half-increment towards 0, and values above away from 0.
- `halfEven` — round values at half-increment towards the nearest even value, values above it away from 0, and values below it towards 0.

Value of `null` will use `Math.round`. This value is only kept for backward compatibility and will be removed in the next major release, in which `"halfExpand"` will be made the new default.
Value of `null` will use `Math.round`. This value is only kept for backward compatibility and will be removed in the next major release, in which `"trunc"` will be made the new default.

**Default**: `null`.

Expand Down
2 changes: 1 addition & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ export interface FormatOptions extends FormatRelativeTimeOptions {
*
* Value of `null` will use `Math.round`. This value is only kept for backward
* compatibility, and will be removed in the next major release, in which
* `"halfExpand"` will be made a new default.
* `"trunc"` will be made a new default.
*
* @default null // Use `Math.round` (deprecated)
*/
Expand Down

0 comments on commit eba537b

Please sign in to comment.