refactor!: rename distributedTtl option to distributedLease#551
Merged
Conversation
`distributedTtl` (introduced in 4.4.0) was the only abbreviation in the options API, and the `Ttl` suffix read poorly. Rename it to `distributedLease`: same meaning (the safety lease in ms for lease-based coordinators), no abbreviation, and it groups with `distributed` in autocomplete. Removed without an alias since it shipped only days ago in 4.4.0.
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
1 participant
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.
Renames the
distributedTtltask option todistributedLease(same meaning: the safety lease, in ms, for lease-based run coordinators).distributedTtlwas the only abbreviation in the options API (the rest are spelled out:maxExecutions,executeTimeout,missedExecutionTolerance, …) andTtlread poorly.distributedLeasedrops the abbreviation and groups withdistributedin autocomplete; a "lease" is inherently a bounded duration.It was introduced in 4.4.0 (days ago), so it's removed without an alias.
TaskOptions.distributedTtl→distributedTtlbecomesdistributedLease[Unreleased]) updatedDocs updated in node-cron-site#20.
Build, lint, and the full suite (374 tests) pass.