Change Koa openSegment middleware declaration return type to match expected Koa.Middleware type #525
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.
Issue #, if available: This PR fixes issue #522
Description of changes:
The issue above mentions a type error that occurs when using the
opensegment
middleware in koa and typescript due to a mismatch between the expected return type,Koa.Middleware
, and the type declared for the opensegment middleware,Function
.The type declaration is updated below to fix this issue and avoid this manual workaround:
app.use(XRayKoa.openSegment("test") as Koa.Middlware);
and allow for consistency in using this middleware in JS & TS.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.