docs: Add type annotation to params#206
Draft
Lang-Qiu wants to merge 1 commit into
Draft
Conversation
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.
问题背景
原始函数参数 'params' 缺少类型注解,导致调用者不清楚其预期结构(如 inputId 和 logger 属性)。这增加了代码的歧义,可能引发错误或误解。
修改内容
plugins/app-builder/skills/appbuilder-action-scaffolder/assets/action-scaffold-template.js文件。exports.main函数上添加了 JSDoc 注解,指定了params参数的类型为{ inputId: string, logger?: object }。验证方式
其他信息