Ucalgary_Baja/BajaUofCWebsite
4
0
Fork 0
mirror of https://github.com/UofCBaja/BajaUofCWebsite.git synced 2025-06-15 21:34:17 -06:00
Code Issues Packages Projects Releases Wiki Activity

added jsdoc comments to fakeDelay tool

Browse Source
This commit is contained in:
darkicewolf50 2024-03-12 12:24:54 -06:00
parent 3d0872bd96
commit 09fd161ba2
1 changed files with 10 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/TestingTools/fakeDelay.js
View File

@ -1,18 +1,12 @@
/**
function fakeDelay(ms) { * @param {int} ms - time in ms to add a delay
/* * @returns {Promise(resolve)} Promise - reutrns an empty promise after the set time
useful for testing allows for a fake response, allow us to see what the program does while waiting for data from the backend * @description Testing tool to delay a function deliberatly
REQUIRES: * @author Brock <darkicewolf50@gmail.com>
time in milliseconds * @example await fakeDelay(5000);
needs a line like this to run
await fakeDelay(5000);
PROMISES:
nothing
Develop in part by: Brock
Contact: darkicewolf50@gmial.com
*/ */
return new Promise(resolve => setTimeout(resolve, ms)); function fakeDelay(ms) {
return new Promise((resolve) => setTimeout(resolve, ms));
} }
export default fakeDelay; export default fakeDelay;