feat(ts): loosening up the IncomingMessage and ServerResponse typings #295
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
The typings on the various instances of `IncomingMessage` and `ServerResponse` are too strict when coupled with Express and Fastify `Request` instances that have been extended for custom properties. This loosens them up by allowing the main `pino` instance to be supplied a generic of the Request and Response interfaces that you use in your application. Fixes pinojs#294
erunion
commented
Aug 30, 2023
| const logger = pino(); | ||
|
|
||
| pinoHttp(); | ||
| pinoHttp({ logger }); | ||
| pinoHttp({ logger }).logger = logger; | ||
| pinoHttp<CustomRequest, CustomResponse>({ logger }); | ||
|
|
||
| // #genReqId |
There was a problem hiding this comment.
The generic tests I added added a lot of clutter to this file so I've broken these option tests visually up a bit so it's easier to grok.
erunion
commented
Aug 30, 2023
| @@ -12,41 +12,41 @@ import { IncomingMessage, ServerResponse } from 'http'; | |||
| import pino from 'pino'; | |||
| import { err, req, res, SerializedError, SerializedRequest, SerializedResponse } from 'pino-std-serializers'; | |||
|
|
|||
| declare function PinoHttp(opts?: Options, stream?: pino.DestinationStream): HttpLogger; | |||
| declare function PinoHttp<IM = IncomingMessage, SR = ServerResponse>(opts?: Options<IM, SR>, stream?: pino.DestinationStream): HttpLogger<IM, SR>; | |||
There was a problem hiding this comment.
Originally had all of these as <Request = IncomingMessage, Response = ServerResponse> but that added a ton of visual clutter to this file. I'm happy to revise these though if you'd like.
mosesj-readme
approved these changes
Aug 30, 2023
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.
Fixes #294
The typings on the various instances of
IncomingMessageandServerResponseare too strict when coupled with Express and FastifyRequestinstances that have been extended for custom properties. This loosens them up by allowing the mainpinoinstance to be supplied a generic of the Request and Response interfaces that you use in your application.Here it is in action:
And before without this generic, TS doesn't recognize our
projectproperty being on our ExpressRequestobject: