Skip to content

docs: update res.clearCookie documentation for clarity and accuracy - #2000

Merged
bjohansebas merged 2 commits into
gh-pagesfrom
res.clearCookie
Aug 15, 2025
Merged

docs: update res.clearCookie documentation for clarity and accuracy#2000
bjohansebas merged 2 commits into
gh-pagesfrom
res.clearCookie

Conversation

@bjohansebas

@bjohansebasbjohansebas commented Aug 2, 2025

Copy link
Copy Markdown
Member

Improve the message by expanding on how the cookie is cleared, and include a note about the deprecation of the max-age and expires options: in Express 4 they are still respected (not ignored), whereas in Express 5 they are ignored.

ref: expressjs/express#5792
ref: expressjs/express#5640
ref: expressjs/express#5672

closes: #1146

Preview: https://deploy-preview-2000--expressjscom-preview.netlify.app/en/4x/api.html#res.clearCookie, https://deploy-preview-2000--expressjscom-preview.netlify.app/en/5x/api.html#res.clearCookie

Note: We need to manage changes more effectively. Whenever there are changes, and once they have been released, a PR should be opened here to update the documentation. Improving these processes will help us keep our documentation better maintained.

cc: @expressjs/express-collaborators @expressjs/docs-wg

Signed-off-by: Sebastian Beltran <bjohansebas@gmail.com>
@bjohansebas
bjohansebas requested a review from a team as a code ownerAugust 2, 2025 16:48
@netlify

netlifyBot commented Aug 2, 2025

Copy link
Copy Markdown

Deploy Preview for expressjscom-preview ready!

NameLink
🔨 Latest commitf2e0f35
🔍 Latest deploy loghttps://app.netlify.com/projects/expressjscom-preview/deploys/688fd5600acd6c0008bb59a8
😎 Deploy Previewhttps://deploy-preview-2000--expressjscom-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions

This comment was marked as off-topic.

@bjohansebasbjohansebas added docs Issues/pr concerning content 5.x Docs for 5.x version 4.x Docs for 4.x version labels Aug 3, 2025
@github-actions

This comment was marked as duplicate.

@ShubhamOulkarShubhamOulkar left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@bjohansebas
bjohansebas merged commit 8c1e4b3 into gh-pagesAug 15, 2025
13 checks passed
@bjohansebas
bjohansebas deleted the res.clearCookie branch August 15, 2025 21:29
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

4.xDocs for 4.x version5.xDocs for 5.x versiondocsIssues/pr concerning content

Projects

None yet

Development

Successfully merging this pull request may close these issues.

res.clearCookie API underdocumented

2 participants

@bjohansebas@ShubhamOulkar