Differentiate options for sync and async SSRC initialization #2506
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
lahirumaramba
approved these changes
Mar 25, 2024
| @@ -354,7 +354,21 @@ export interface ServerTemplateData { | |||
| /** | |||
| * Represents optional arguments that can be used when instantiating {@link ServerTemplate}. | |||
| */ | |||
| export interface ServerTemplateOptions { | |||
| export interface GetServerTemplateOptions { | |||
There was a problem hiding this comment.
Does it makes sense to create a base type and extend from it?
export interface InitServerTemplateOptions extends GetServerTemplateOptions {
template?: ServerTemplateData,
}
There was a problem hiding this comment.
Makes sense. I'll update it.
Per feedback on PR.
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.
Discussion
It doesn't make sense to pass a cached template to
getServerTemplatebecause the method loads a new template immediately.I see a recommendation to define distinct interfaces for method options: microsoft/tsdoc#19.
So, this change splits
ServerTemplateOptionsintoGetServerTemplateOptionsandInitServerTemplateOptions.Testing
Tested with
npm test.API Changes
Splits
ServerTemplateOptionsintoGetServerTemplateOptionsandInitServerTemplateOptions.