@cerebrusinc/qol - npm Package Compare versions

Comparing version 1.1.1 to 1.2.0

lib/index.d.ts

@@ -5,2 +5,3 @@ import randomColour from "./modules/randomColour";
 import Logger from "./modules/logger";
-export { randomColour, parseDate, DateObject, numParse, Logger };
+import sleep from "./modules/sleep";
+export { randomColour, parseDate, DateObject, numParse, Logger, sleep };

lib/index.js

@@ -6,3 +6,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Logger = exports.numParse = exports.parseDate = exports.randomColour = void 0;
+exports.sleep = exports.Logger = exports.numParse = exports.parseDate = exports.randomColour = void 0;
 var randomColour_1 = __importDefault(require("./modules/randomColour"));
@@ -16,1 +16,3 @@ exports.randomColour = randomColour_1.default;
 exports.Logger = logger_1.default;
+var sleep_1 = __importDefault(require("./modules/sleep"));
+exports.sleep = sleep_1.default;

package.json

 {
 	"name": "@cerebrusinc/qol",
-	"version": "1.1.1",
+	"version": "1.2.0",
 	"description": "This is a host of quality of life features that take the load off of coding; A mix of random but cool functions!",
@@ -5,0 +5,0 @@ "author": {

README.md

@@ -223,7 +223,66 @@ <p align="center">
 
+## sleep
+
+Mimics python's `time.sleep` function when a delay is needed to mimic processes such as an API call.
+
+Returns a `Promise<unknown>`
+
+```ts
+const fetchData = async (): Promise<string> => {
+	try {
+		await sleep(1200);
+		return "data";
+	} catch {
+		return "fetchData error";
+	}
+};
+
+console.log(fetchData());
+// data
+```
+
+You can also mimick an error by setting the error arg to `true`:
+
+```ts
+const fetchData = async (): Promise<string> => {
+	try {
+		// set it to true
+		await sleep(1200, true);
+		return "data";
+	} catch {
+		return "fetchData error";
+	}
+};
+
+console.log(fetchData());
+// fetchData error
+```
+
+<details>
+<summary><strong>Params</strong></summary>
+
+| Parameter | Default Setting | Required? | Definition                       | Options                                                    |
+| --------- | --------------- | --------- | -------------------------------- | ---------------------------------------------------------- |
+| value     | `undefined`     | Yes       | The number you want to be parsed | `none`                                                     |
+| setting   | `comma`         | No        | The delimiter for the number     | `space`, `comma`, `punct`, any other delimiter as a string |
+
+</details>
+<br />
+
 # Changelog
 
+## v1.2.x
+
+<details open>
+<summary><strong>v1.2.0</strong></summary>
+
+- added `sleep` async function
+  - mimcs python's `time.sleep`
+
+</details>
+<br />
+
 ## v1.1.x
 
-<details open>
+<details>
 <summary><strong>v1.1.1</strong></summary>
@@ -230,0 +289,0 @@

src/index.ts

@@ -5,3 +5,4 @@ import randomColour from "./modules/randomColour";
 import Logger from "./modules/logger";
+import sleep from "./modules/sleep";
 
-export { randomColour, parseDate, DateObject, numParse, Logger };
+export { randomColour, parseDate, DateObject, numParse, Logger, sleep };

No alert changes

Improved metrics

Total package byte prevSize

68943

increased by5.08%

Number of package files

22

increased by10%

Lines of code

1125

increased by3.4%

Number of lines in readme file

360

increased by19.6%

No dependency changes