fix(sdk): explicit type for project template #1779
Merged
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.
Current Behavior
When working with the public API methods, such as
openProject
, it is unclear what the available options for the templates are. When executing these functions, Stackblitz will throw an error on the site about an invalid template, but does not inform developers about available template values.New Behavior
This PR makes the
template
value of theProject
interface have strict types of the available options. This allows developers to know the available template values when working with the public API.Other Information
It appears the API documentation: https://developer.stackblitz.com/docs/platform/javascript-sdk/#sdkopenprojectproject-opts could also be updated to reference the current latest list.