Skip to content

Commit 3be8dde

Browse files
Add JSDoc documentation to enqueueTask function
Added comprehensive JSDoc comments to the enqueueTask function to document: - The purpose of the function - Behavior differences between Node.js and browser environments - Parameter and return type information This improves code documentation and developer experience.
1 parent 45d4e91 commit 3be8dde

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

packages/shared/enqueueTask.js

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,16 @@
1010
let didWarnAboutMessageChannel = false;
1111
let enqueueTaskImpl = null;
1212

13+
/**
14+
* Enqueues a task to be executed asynchronously.
15+
*
16+
* In Node.js environments, this uses `setImmediate` to bypass fake timers.
17+
* In browser environments, this uses `MessageChannel` to ensure the task
18+
* runs asynchronously even when timers are faked (e.g., in tests).
19+
*
20+
* @param {() => void} task - The function to execute asynchronously.
21+
* @returns {void}
22+
*/
1323
export default function enqueueTask(task: () => void): void {
1424
if (enqueueTaskImpl === null) {
1525
try {

0 commit comments

Comments
 (0)