@bscotch/utility - npm Package Compare versions

Comparing version 0.5.2 to 0.6.0

build/lib/wait.d.ts

@@ -1,3 +0,5 @@
-export declare function waitForMillis(millis: number): Promise<unknown>;
-export declare function waitForSeconds(seconds: number): Promise<unknown>;
+/** Get a promise that resolves in some number of milliseconds. */
+export declare function resolveInMillis(millis: number): Promise<unknown>;
+/** Get a promise that resolves in some number of seconds. */
+export declare function resolveInSeconds(seconds: number): Promise<unknown>;
 //# sourceMappingURL=wait.d.ts.map

build/lib/wait.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.waitForSeconds = exports.waitForMillis = void 0;
-function waitForMillis(millis) {
+exports.resolveInSeconds = exports.resolveInMillis = void 0;
+/** Get a promise that resolves in some number of milliseconds. */
+function resolveInMillis(millis) {
     return new Promise(res => setTimeout(res, millis));
 }
-exports.waitForMillis = waitForMillis;
-function waitForSeconds(seconds) {
-    return waitForMillis(seconds * 1000);
+exports.resolveInMillis = resolveInMillis;
+/** Get a promise that resolves in some number of seconds. */
+function resolveInSeconds(seconds) {
+    return resolveInMillis(seconds * 1000);
 }
-exports.waitForSeconds = waitForSeconds;
+exports.resolveInSeconds = resolveInSeconds;
 //# sourceMappingURL=wait.js.map

CHANGELOG.md

@@ -0,1 +1,10 @@
+# [0.6.0](https://github.com/bscotch/node-util/compare/v0.5.2...v0.6.0) (2020-11-11)
+
+
+### Features
+
+* Rename wait methods to 'resolveInSeconds' etc to be more explicit about what's happening. ([df5c6ab](https://github.com/bscotch/node-util/commit/df5c6abd41c4c60587e26d4a8e9f3fde04c67cea))
+
+
+
 ## [0.5.2](https://github.com/bscotch/node-util/compare/v0.5.1...v0.5.2) (2020-11-11)
@@ -2,0 +11,0 @@

package.json

 {
   "name": "@bscotch/utility",
-  "version": "0.5.2",
+  "version": "0.6.0",
   "description": "Bscotch Utilities: Methods for common Node.js needs.",
@@ -5,0 +5,0 @@ "engines": {

README.md

@@ -126,1 +126,17 @@ # Bscotch Utilities
 ```
+
+## Waits
+
+```ts
+import {
+  resolveInMillis,
+  resolveInSeconds,
+} from '@bscotch/utility';
+
+async myAsynFunction(){
+  // Wait for 1 second
+  await resolveInMillis(1000);
+  // Wait for 1 second
+  await resolveInSeconds(1);
+}
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

27492

increased by3.24%

Lines of code

297

increased by1.37%

Number of lines in readme file

142

increased by12.7%

No dependency changes