support for async call to repo sync using options pattern#75
Closed
3choBoomer wants to merge 1 commit into
Closed
Conversation
Author
|
Closing in favor of #76 |
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.
Summary
Adds support for triggering an asynchronous repository sync by introducing a functional options pattern on the existing
RepoListSyncmethod.This is one of two proposed approaches to resolve #74, which has been open since 2024. See #XX for an alternative implementation that adds a dedicated
RepoListSyncAsync()function instead.Changes
RepoListSyncOptionfunctional option typeWithRepoListSyncAsync()option constructor, which appendsasync=trueto the request URLRepoListSyncin both theClientinterface andclientimplementation to acceptopts ...RepoListSyncOptionUsage
Notes
RepoListSync()continue to work without modification.The functional options pattern also leaves room for future query parameters to be added without further signature changes.
Alternatives
See #76 for an alternative that adds a dedicated
RepoListSyncAsync()function instead. That approach keeps theClientinterface flat and makes the async behaviour self-documenting via the function name, at the cost of a new method per option.