fix(types): document cookie secure and httpOnly defaults as true - #353
Merged
Tony133 merged 2 commits intoJul 28, 2026
Merged
Conversation
Align CookieOptions JSDoc with runtime and README defaults so editors no longer inherit @fastify/cookie false defaults. Fixes fastify#299
Member
|
The fix looks great! Could you also update the type test file to include assertions for see here: https://github.com/fastify/session/blob/main/types/index.tst.ts#L59 - const cookieMaxAge: CookieOptions = {}
- expect(cookieMaxAge.maxAge).type.toBe<number | undefined>()
+ const cookieOptions: CookieOptions = {}
+ expect(cookieOptions.maxAge).type.toBe<number | undefined>()
+ expect(cookieOptions.httpOnly).type.toBe<boolean | undefined>()
+ expect(cookieOptions.secure).type.toBe<boolean | 'auto' | undefined>() |
Contributor
Author
|
Updated |
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
httpOnlyandsecureonCookieOptionswith@default trueJSDoc so IDE tooltips match runtime and README behavior.@fastify/cookieCookieSerializeOptions, which documents defaults asfalse.Fixes #299
Test plan
npm run test:typescriptnpm run test:unit(100% coverage)