From 09fd161ba2197cd6111746b11509de6ee65d7ec7 Mon Sep 17 00:00:00 2001 From: darkicewolf50 Date: Tue, 12 Mar 2024 12:24:54 -0600 Subject: [PATCH] added jsdoc comments to fakeDelay tool --- src/TestingTools/fakeDelay.js | 26 ++++++++++---------------- 1 file changed, 10 insertions(+), 16 deletions(-) diff --git a/src/TestingTools/fakeDelay.js b/src/TestingTools/fakeDelay.js index 58c3c46..0a03269 100644 --- a/src/TestingTools/fakeDelay.js +++ b/src/TestingTools/fakeDelay.js @@ -1,18 +1,12 @@ - +/** + * @param {int} ms - time in ms to add a delay + * @returns {Promise(resolve)} Promise - reutrns an empty promise after the set time + * @description Testing tool to delay a function deliberatly + * @author Brock + * @example await fakeDelay(5000); + */ function fakeDelay(ms) { - /* - useful for testing allows for a fake response, allow us to see what the program does while waiting for data from the backend - REQUIRES: - time in milliseconds - - 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)); - } + return new Promise((resolve) => setTimeout(resolve, ms)); +} -export default fakeDelay; \ No newline at end of file +export default fakeDelay;