[v4] Deprecate res.clearCookie accepting options.maxAge and options.expires
#5672
Conversation
This file contains 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
wesleytodd
requested changes
May 22, 2024
wesleytodd
approved these changes
May 29, 2024
| @@ -822,6 +822,14 @@ res.get = function(field){ | |||
| */ | |||
|
|
|||
| res.clearCookie = function clearCookie(name, options) { | |||
| if (options) { | |||
There was a problem hiding this comment.
Sorry to make a comment on this again lol, take this as a nitpick, but if these checks were just made below line 833 they could assume opts and just be the individual if's.
| @@ -822,6 +822,14 @@ res.get = function(field){ | |||
| */ | |||
|
|
|||
| res.clearCookie = function clearCookie(name, options) { | |||
| if (options) { | |||
| if (options.maxAge) { | |||
| deprecate('res.clearCookie: Passing "options.maxAge" is deprecated and should be removed. Starting with the next major release of Express, this option will be ignored, as res.clearCookie will automatically set cookies to expire immediately. Please update your code to omit this option.'); | |||
There was a problem hiding this comment.
Should we call out v5.0.0 here so that we can be sure to not accidentally miss confusing folks in the future who may not know this was landed in v4?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
closes #5640
Adds a deprecation notice when users pass a truthy value in
optionsformaxAgeorexpireswhen callingres.clearCookie(name, options).example:
Related #4852