assertron 9.1.0 → 9.2.0

package/README.md

@@ -1,13 +1,10 @@
-<!-- markdownlint-disable MD024 -->
-
 # assertron
 
 [![NPM version][npm-image]][npm-url]
 [![NPM downloads][downloads-image]][downloads-url]
 
-[![Github NodeJS][github-nodejs]][github-action-url]
+[![GitHub NodeJS][github-nodejs]][github-action-url]
 [![Codecov][codecov-image]][codecov-url]
-[![Coverage Status][coveralls-image]][coveralls-url]
 
 [![Semantic Release][semantic-release-image]][semantic-release-url]
 
@@ -15,41 +12,37 @@
 
 A supplementary assertion library that runs on both NodeJS and browser.
 
-## assertron
-
-`assertron` provides a collection of assertion methods.
-
-### assertron.false(value)
-
-Asserts the provided value is false.
-
-### assertron.falsy(value)
+## Install
 
-Asserts the provided value is falsy.
-
-### assertron.pathEqual(actual, expected)
-
-Asserts the two paths are equal regardless of operating system differences.
-
-### assertron.rejects(promise)
-
-Asserts the promise rejects.
+```sh
+# npm
+npm install assertron
 
-### assertron.repeat(fn, times)
+# yarn
+yarn add assertron
 
-Repeat the specified function n times and return the last result.
-If the result is a promise, it will run the function sequentially.
+# pnpm
+pnpm install assertron
 
-### assertron.resolves(promise)
+#rush
+rush add -p assertron
+```
 
-Asserts the promise resolves.
+## Usage
 
-### assertron.satisfies(actual, expected)
+`assertron` provides a collection of assertion methods:
 
-`assertron.satisfies()` checks if `actual` meets the requirements specified by `expected`.
-Each property in `expected` can be a value, a `RegExp`, or a predicate function.
-It uses `satisfier` internally to check for validity.
-Check out [`satisfier`](https://github.com/unional/satisfier) for more detail.
+- `assertron.false(value)`: asserts the provided value is false.
+- `assertron.falsy(value)`: asserts the provided value is falsy.
+- `assertron.pathEqual(actual, expected)`: asserts the two paths are equal regardless of operating system differences.
+- `assertron.rejects(promise)`: asserts the promise rejects.
+- `assertron.repeat(fn, times)`: repeat the specified function n times and return the last result.\
+  If the result is a promise, it will run the function sequentially.
+- `assertron.resolves(promise)`: asserts the promise resolves.
+- `assertron.satisfies(actual, expected)`: checks if `actual` meets the requirements specified by `expected`.\
+  Each property in `expected` can be a value, a `RegExp`, or a predicate function.\
+  It uses `satisfier` internally to check for validity.\
+  Check out [`satisfier`](https://github.com/unional/satisfier) for more detail.
 
 ```ts
 import a from 'assertron' // assertron is also exported as default.
@@ -66,9 +59,7 @@ a.satisfies({ a: 'foo' }, { a: /boo/ })
 a.satisfies({ a: 1 }, { a: () => false })
 ```
 
-### assertron.throws(...)
-
-Asserts the promise, function, or async function throws (or rejects) an error.
+- `assertron.throws(...)`: asserts the promise, function, or async function throws (or rejects) an error.
 
 ```ts
 import { assertron } from 'assertron'
@@ -82,21 +73,14 @@ const e2 = assertron.throws(() => { throw new SpecificError('foo') }, SpecificEr
 const e3 = await assertron.throws(() => Promise.reject(new SpecificError('foo')), SpecificError)
 ```
 
-### assertron.true(value)
-
-Asserts the provided value is true.
-
-### assertron.truthy(value)
-
-Asserts the provided value is truthy.
+- `assertron.true(value)`: asserts the provided value is true.
+- `assertron.truthy(value)`: asserts the provided value is truthy.
 
 ## AssertOrder
 
 Assert the code is executed in the expected order.
 
-### order.once(step: number)
-
-Asserts the step `step` executed once.
+- `order.once(step: number)`: asserts the step `step` executed once.
 
 ```ts
 import { AssertOrder } from 'assertron'
@@ -126,9 +110,7 @@ foo()
 boo()
 ```
 
-### order.atLeastOnce(step: number)
-
-Assert the `step` executed at least once.
+- `order.atLeastOnce(step: number)`: assert the `step` executed at least once.
 
 ```ts
 import { AssertOrder } from 'assertron'
@@ -142,9 +124,7 @@ for (let i = 0; i < 10; i++)
 o.once(2)
 ```
 
-### order.exactly(step: number, times: number)
-
-Asserts the step `step` executed exactly n times
+- `order.exactly(step: number, times: number)`: asserts the step `step` executed exactly n times
 
 ```ts
 import { AssertOrder } from 'assertron'
@@ -155,9 +135,7 @@ for (let i = 0; i < 4; i++)
   o.exactly(1, 3) // throws at i === 3
 ```
 
-### order.any(steps: number[])
-
-Asserts any of the steps `steps` executed.
+- `order.any(steps: number[])`: asserts any of the steps `steps` executed.
 
 ```ts
 import { AssertOrder } from 'assertron'
@@ -190,7 +168,7 @@ git push
 # create PR
 ```
 
-## Npm Commands
+## NPM Commands
 
 There are a few useful commands you can use during development.
 
@@ -211,8 +189,6 @@ yarn verify
 [github-action-url]: https://github.com/unional/assertron/actions
 [codecov-image]: https://codecov.io/gh/unional/assertron/branch/master/graph/badge.svg
 [codecov-url]: https://codecov.io/gh/unional/assertron
-[coveralls-image]: https://coveralls.io/repos/github/unional/assertron/badge.svg
-[coveralls-url]: https://coveralls.io/github/unional/assertron
 
 [semantic-release-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
 [semantic-release-url]: https://github.com/semantic-release/semantic-release

package/cjs/assertron/rejects.js

@@ -4,7 +4,7 @@ exports.rejects = void 0;
 var errors_js_1 = require("../errors.js");
 var index_js_1 = require("../utils/index.js");
 function rejects(promise) {
-    return promise.then(function (value) { throw new errors_js_1.AssertionError((0, index_js_1.notRejectedMessage)(value), { ssf: rejects }); }, function () { });
+    return promise.then(function (value) { throw new errors_js_1.AssertionError((0, index_js_1.notRejectedMessage)(value), { ssf: rejects }); }, function (err) { return err; });
 }
 exports.rejects = rejects;
 //# sourceMappingURL=rejects.js.map

package/cjs/assertron/rejects.js.map

@@ -1 +1 @@
-{"version":3,"file":"rejects.js","sourceRoot":"","sources":["../../ts/assertron/rejects.ts"],"names":[],"mappings":";;;AAAA,0CAA6C;AAC7C,8CAAsD;AAEtD,SAAgB,OAAO,CAAC,OAAqB;IAC3C,OAAO,OAAO,CAAC,IAAI,CACjB,UAAA,KAAK,IAAM,MAAM,IAAI,0BAAc,CAAC,IAAA,6BAAkB,EAAC,KAAK,CAAC,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAA,CAAC,CAAC,EAClF,cAAQ,CAAC,CACV,CAAA;AACH,CAAC;AALD,0BAKC"}
+{"version":3,"file":"rejects.js","sourceRoot":"","sources":["../../ts/assertron/rejects.ts"],"names":[],"mappings":";;;AAAA,0CAA6C;AAC7C,8CAAsD;AAEtD,SAAgB,OAAO,CAAC,OAAqB;IAC3C,OAAO,OAAO,CAAC,IAAI,CACjB,UAAA,KAAK,IAAM,MAAM,IAAI,0BAAc,CAAC,IAAA,6BAAkB,EAAC,KAAK,CAAC,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAA,CAAC,CAAC,EAClF,UAAA,GAAG,IAAI,OAAA,GAAG,EAAH,CAAG,CACX,CAAA;AACH,CAAC;AALD,0BAKC"}

package/cjs/index.js

@@ -14,7 +14,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.a = void 0;
 var index_js_1 = require("./assertron/index.js");
+Object.defineProperty(exports, "a", { enumerable: true, get: function () { return index_js_1.assertron; } });
 __exportStar(require("./assert-order/index.js"), exports);
 __exportStar(require("./assertron/index.js"), exports);
 __exportStar(require("./errors.js"), exports);

package/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../ts/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAAgD;AAEhD,0DAAuC;AACvC,uDAAoC;AACpC,8CAA2B;AAC3B,kBAAe,oBAAS,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../ts/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,iDAAgD;AAM1B,kFANb,oBAAS,OAMK;AAJvB,0DAAuC;AACvC,uDAAoC;AACpC,8CAA2B;AAC3B,kBAAe,oBAAS,CAAA"}

package/esm/assertron/rejects.js

@@ -1,6 +1,6 @@
 import { AssertionError } from '../errors.js';
 import { notRejectedMessage } from '../utils/index.js';
 export function rejects(promise) {
-    return promise.then(value => { throw new AssertionError(notRejectedMessage(value), { ssf: rejects }); }, () => { });
+    return promise.then(value => { throw new AssertionError(notRejectedMessage(value), { ssf: rejects }); }, err => err);
 }
 //# sourceMappingURL=rejects.js.map

package/esm/assertron/rejects.js.map

@@ -1 +1 @@
-{"version":3,"file":"rejects.js","sourceRoot":"","sources":["../../ts/assertron/rejects.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAEtD,MAAM,UAAU,OAAO,CAAC,OAAqB;IAC3C,OAAO,OAAO,CAAC,IAAI,CACjB,KAAK,CAAC,EAAE,GAAG,MAAM,IAAI,cAAc,CAAC,kBAAkB,CAAC,KAAK,CAAC,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAA,CAAC,CAAC,EAClF,GAAG,EAAE,GAAG,CAAC,CACV,CAAA;AACH,CAAC"}
+{"version":3,"file":"rejects.js","sourceRoot":"","sources":["../../ts/assertron/rejects.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAEtD,MAAM,UAAU,OAAO,CAAC,OAAqB;IAC3C,OAAO,OAAO,CAAC,IAAI,CACjB,KAAK,CAAC,EAAE,GAAG,MAAM,IAAI,cAAc,CAAC,kBAAkB,CAAC,KAAK,CAAC,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAA,CAAC,CAAC,EAClF,GAAG,CAAC,EAAE,CAAC,GAAG,CACX,CAAA;AACH,CAAC"}

package/esm/index.js

@@ -3,4 +3,5 @@ export * from './assert-order/index.js';
 export * from './assertron/index.js';
 export * from './errors.js';
 export default assertron;
+export { assertron as a };
 //# sourceMappingURL=index.js.map

package/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../ts/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAEhD,cAAc,yBAAyB,CAAA;AACvC,cAAc,sBAAsB,CAAA;AACpC,cAAc,aAAa,CAAA;AAC3B,eAAe,SAAS,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../ts/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAEhD,cAAc,yBAAyB,CAAA;AACvC,cAAc,sBAAsB,CAAA;AACpC,cAAc,aAAa,CAAA;AAC3B,eAAe,SAAS,CAAA;AACxB,OAAO,EAAE,SAAS,IAAI,CAAC,EAAE,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "assertron",
-  "version": "9.1.0",
+  "version": "9.2.0",
   "description": "A supplementary assertion library",
   "homepage": "https://github.com/unional/assertron",
   "bugs": {

package/ts/assertron/rejects.ts

@@ -4,6 +4,6 @@ import { notRejectedMessage } from '../utils/index.js'
 export function rejects(promise: Promise<any>) {
   return promise.then(
     value => { throw new AssertionError(notRejectedMessage(value), { ssf: rejects }) },
-    () => { }
+    err => err
   )
 }

package/ts/index.ts

@@ -4,3 +4,4 @@ export * from './assert-order/index.js'
 export * from './assertron/index.js'
 export * from './errors.js'
 export default assertron
+export { assertron as a }