build: include bundled TypeScript declarations#407
Open
jeanpierrecarvalho wants to merge 1 commit intoexpressjs:masterfrom
Open
build: include bundled TypeScript declarations#407jeanpierrecarvalho wants to merge 1 commit intoexpressjs:masterfrom
jeanpierrecarvalho wants to merge 1 commit intoexpressjs:masterfrom
Conversation
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.
Summary
index.d.tscopied from the current@types/corsdefinitionstypesfield and include them in the published files listheadersoption alias typed, marked as deprecated, to match current runtime behaviorWhy
Issue #235 asks to ship TypeScript definitions with
corsinstead of requiring a separate@types/corsinstall.This change keeps the types lightweight and aligned with the current middleware API while improving the out-of-the-box TypeScript experience for consumers.
Impact
TypeScript users can install
corsalone and get bundled declarations immediately.Existing code using the legacy
headersalias continues to type-check, while new code is steered towardallowedHeaders.Validation
npm testcors(),cors.CorsOptionsDelegate<Request>, and the legacyheadersaliasAddresses #235.