feat: Add customTag parameter to the tunnelConnectResponded event
#411
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
…dd tunnelConnectError event
github-actions
bot
added
the
t-platform
jancurn
approved these changes
Feb 27, 2023
src/server.ts
Outdated
| @@ -73,6 +74,7 @@ export type PrepareRequestFunctionResult = { | |||
| localAddress?: string; | |||
| ipFamily?: number; | |||
| dnsLookup?: typeof dns['lookup']; | |||
| metadata?: Record<string, unknown>; | |||
There was a problem hiding this comment.
Please can you document this in readme?
There was a problem hiding this comment.
btw does this need to be a dictionary? why not any object user-supplied object?
fnesveda
approved these changes
Feb 28, 2023
mtrunkat
approved these changes
Feb 28, 2023
jancurn
reviewed
Mar 1, 2023
README.md
Outdated
|
|
||
| // Optional metadata that will be passed back via | ||
| // `tunnelConnectResponded` or `tunnelConnectFailed` events | ||
| metadata: { userId: '123' }, |
There was a problem hiding this comment.
sorry, just one last note 🙈 wouldn't it make more sense to call this tag or customTag rather than metadata? metadata has a specific meaning. Your call @jirimoravcik
There was a problem hiding this comment.
Good point, I went with customTag, smaller chance of a meaning conflict due to the name
jirimoravcik
changed the title
metadata parameter to the tunnelConnectResponded eventcustomTag parameter to the tunnelConnectResponded event
fnesveda
added
the
validated
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.
Also add
tunnelConnectFailedevent.This is used to pass information that was passed by
prepareRequestFunctionback via events