Add sleep (#22)

CHANGELOG.md

@@ -13,6 +13,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+## [1.4.0] - 2021-10-26
+
+### Added
+
+- `sleep`
+
+### Changed
+
+### Removed
+
 ## [1.3.0] - 2021-10-20
 
 ### Added

README.md

@@ -51,6 +51,7 @@ npm i @techmmunity/utils
 | function   | description                                     |
 | ---------- | ----------------------------------------------- |
 | `cleanObj` | Remove undefined and null values from an object |
+| `sleep`    | Await the amount of time specified (in seconds) |
 
 ## `get*`
 

jest.config.js

@@ -13,6 +13,7 @@ module.exports = {
 	testEnvironment: "node",
 	moduleDirectories: ["node_modules", "src"],
 	resetMocks: true,
+	testTimeout: 15000,
 	coverageThreshold: {
 		global: {
 			statements: 99.17,

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@techmmunity/utils",
-	"version": "1.3.0",
+	"version": "1.4.0",
 	"main": "index.js",
 	"types": "index.d.ts",
 	"license": "Apache-2.0",

src/index.ts

@@ -7,6 +7,7 @@
  */
 
 export * from "./lib/clean-obj";
+export * from "./lib/sleep";
 
 /**
  * ---------------------------------------------------------------------------

src/lib/sleep/index.ts

@@ -0,0 +1,6 @@
+/**
+ * Await the amount of time specified (in seconds)
+ */
+export const sleep = (seconds: number): Promise<void> =>
+	// eslint-disable-next-line @typescript-eslint/no-magic-numbers
+	new Promise(resolve => setTimeout(resolve, seconds * 1000));

src/tests/sleep.spec.ts

@@ -0,0 +1,36 @@
+/**
+ *
+ * True
+ *
+ */
+
+import { isBetween } from "../lib/is-between";
+import { sleep } from "../lib/sleep";
+
+describe("sleep", () => {
+	it("with 1 second", async () => {
+		const timeBefore = Date.now();
+
+		await sleep(1);
+
+		const timeAfter = Date.now();
+
+		const offset = timeAfter - timeBefore;
+
+		// Cannot test the exact time, so test a range
+		expect(isBetween(offset, 1000, 1010)).toBeTruthy();
+	});
+
+	it("with 10 seconds", async () => {
+		const timeBefore = Date.now();
+
+		await sleep(10);
+
+		const timeAfter = Date.now();
+
+		const offset = timeAfter - timeBefore;
+
+		// Cannot test the exact time, so test a range
+		expect(isBetween(offset, 10000, 10010)).toBeTruthy();
+	});
+});