File tree Expand file tree Collapse file tree 1 file changed +5
-6
lines changed Expand file tree Collapse file tree 1 file changed +5
-6
lines changed Original file line number Diff line number Diff line change @@ -11,18 +11,17 @@ import zahl from "zahl"
1111
1212/**
1313 * @typedef {Object } Options
14- * @prop {* } commitMessage If a function is given, it will be called as function(commitManager)
15- * @prop {* } mergeMessage If a function is given, it will be called as function(commitManager, pullNumber)
16- * @prop {* } pullRequestTitle If a function is given, it will be called as function(commitManager)
17- * @prop {* } pullRequestBody If a function is given, it will be called as function(commitManager)
18- * @prop {* } branchPrefix If a function is given, it will be called as function(commitManager)
14+ * @prop {* } commitMessage If a function is given, it will be called as `async function(commitManager)`
15+ * @prop {* } mergeMessage If a function is given, it will be called as `async function(commitManager, pullNumber)`
16+ * @prop {* } pullRequestTitle If a function is given, it will be called as `async function(commitManager)`
17+ * @prop {* } pullRequestBody If a function is given, it will be called as `async function(commitManager)`
18+ * @prop {* } branchPrefix If a function is given, it will be called as `async function(commitManager)`
1919 * @prop {boolean } autoApprove
2020 * @prop {boolean } autoRemoveBranch
2121 * @prop {string } githubTokenInputName
2222 */
2323
2424/**
25- * @class
2625 * @example
2726 * import CommitManager from "commit-from-action"
2827 * const commitManager = new CommitManager
You can’t perform that action at this time.
0 commit comments