Skip to content

Commit

Permalink
Enhance JSDoc description for the cleanupTaskCallback
Browse files Browse the repository at this point in the history
  • Loading branch information
d3xter666 committed Nov 14, 2023
1 parent 2e8d09c commit 61cec42
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion lib/build/helpers/TaskUtil.js
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,16 @@ class TaskUtil {
return this._projectBuildContext.getOption(key);
}

/**
* Callback that will be executed once the build is finished
*
* @public
* @callback @ui5/project/build/helpers/TaskUtil~cleanupTaskCallback
* @param {boolean} force Specifies whether the cleanup callback should
* gracefully wait for certain jobs to be completed
* or enforce immediate termination and cleanup of those jobs.
*/

/**
* Register a function that must be executed once the build is finished. This can be used to, for example,
* clean up files temporarily created on the file system. If the callback returns a Promise, it will be waited for.
Expand All @@ -172,7 +182,8 @@ class TaskUtil {
* This method is only available to custom task extensions defining
* <b>Specification Version 2.2 and above</b>.
*
* @param {Function} callback Callback to register. If it returns a Promise, it will be waited for
* @param {@ui5/project/build/helpers/TaskUtil~cleanupTaskCallback} callback Callback to register.
* If it returns a Promise, it will be waited for
* @public
*/
registerCleanupTask(callback) {
Expand Down

0 comments on commit 61cec42

Please sign in to comment.