types: declare caller option on TransportBaseOptions - #2511
Open
lx3133584 wants to merge 1 commit into
Open
Conversation
Fixes pinojs#2476 Signed-off-by: Liang Xu <lx3133584@users.noreply.github.com>
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.
Problem
While
calleris supported bypino.transportand documented indocs/api.mdfor framework integrations requiring custom caller resolution, passingcallertopino.transport(...)orpino({ transport: { caller: ... } })resulted in a TypeScript compilation error becausecallerwas omitted fromTransportBaseOptionsinpino.d.ts.Cause
TransportBaseOptionsdeclaredoptionsandworkerproperties, but did not declarecaller?: string | string[], causing TypeScript to reject object literals containingcallerdue to excess property checks onTransportSingleOptions,TransportMultiOptions, andTransportPipelineOptions.Fix
caller?: string | string[]topino.TransportBaseOptionsinpino.d.ts.Testing
test/types/pino-transport.tst.tscoveringpino.transportwith single and multiple targets as well aspino({ transport: { ... } })with string and string arraycalleroptions.npm run test-typespasses cleanly across all targets with attw verification.