Update the README to clarify a scenario where a typed property in the context can unexpectedly be undefined #95
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
… context can unexpectedly be undefined.
Eomm
reviewed
Dec 18, 2021
README.md
Outdated
| const foo = requestContext.get('foo') | ||
| ``` | ||
|
|
||
| This also occurs if you have `"strict": true` configured, since enabling Typescript strict mode includes turning on `"strictNullChecks"`. For a discussion about how to work around this and the pros/cons of doing so, please see [fastify/fastify-request-context#93](https://github.com/fastify/fastify-request-context/issues/93). |
There was a problem hiding this comment.
Suggested change
| This also occurs if you have `"strict": true` configured, since enabling Typescript strict mode includes turning on `"strictNullChecks"`. For a discussion about how to work around this and the pros/cons of doing so, please see [fastify/fastify-request-context#93](https://github.com/fastify/fastify-request-context/issues/93). | |
| This also occurs if you have `"strict": true` configured, since enabling Typescript strict mode includes turning on `"strictNullChecks"`. For a discussion about how to work around this and the pros/cons of doing so, please read this [issue #93](https://github.com/fastify/fastify-request-context/issues/93). |
| @@ -104,6 +104,25 @@ const foo = requestContext.get('foo') | |||
| const bar = requestContext.get('bar') | |||
| ``` | |||
|
|
|||
| If you have `"strictNullChecks": true` configured for Typescript project, you will notice that the type of the returned value can still be `undefined` even though the `RequestContextData` interface has a speicfic type: | |||
There was a problem hiding this comment.
Could you add a ## Typescript section above to improve even more the docs?
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.
Checklist
npm run testandnpm run benchmarkand the Code of conduct