types: fix deleteCookie attributes#5460
Open
mayur-shenoy wants to merge 1 commit into
Open
Conversation
Signed-off-by: mayur-shenoy <mayurshenoy2005@gmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Aligns Undici’s TypeScript declarations for deleteCookie() with its documented/runtime behavior, fixing a type drift that prevented valid { path } usage while incorrectly allowing { name } inside the attributes object.
Changes:
- Update
deleteCookie(headers, name, attributes)typing to accept{ path?: string, domain?: string }instead of{ name?: string, domain?: string }. - Add
tsdcoverage to ensure{ path }is accepted and{ name }is rejected in TypeScript.
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
types/cookies.d.ts |
Fixes the deleteCookie attributes type to allow path and disallow redundant name, matching runtime/docs. |
test/types/cookies.test-d.ts |
Adds tsd assertions for accepted/rejected deleteCookie attributes. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
This relates to...
Fixes #5458
Rationale
deleteCookie(headers, name, attributes)acceptspathanddomainat runtime, but the TypeScript declaration exposednameanddomain.The cookie name is already provided as the second argument, so
nameshould not be accepted inside the attributes object. This updates the declaration to match the runtime behavior and existing cookie usage.Changes
Updates the
deleteCookieTypeScript declaration and adds tsd coverage for the accepted/rejected attributes.Features
N/A
Bug Fixes
deleteCookie(headers, name, { path: '/' })in TypeScriptdeleteCookie(headers, name, { name: '...' })in TypeScriptdomainsupported as beforeBreaking Changes and Deprecations
N/A
Status