hein 1.2.3 → 1.3.0

package/CHANGELOG.md

@@ -4,11 +4,22 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [hein@1.3.0](https://github.com/KristjanTammekivi/hein/compare/hein@1.2.3...hein@1.3.0)
+
+> 15 July 2023
+
+- feat: add .fail [`#156`](https://github.com/KristjanTammekivi/hein/issues/156)
+- feat: add .members [`#148`](https://github.com/KristjanTammekivi/hein/issues/148)
+- docs: polish jsdocs [`50b738f`](https://github.com/KristjanTammekivi/hein/commit/50b738f80768df1ec47d347de114818426b10a81)
+- docs: fix build badge [`f897239`](https://github.com/KristjanTammekivi/hein/commit/f897239806aad8f21cf0845a95e60c9c64e45892)
+- docs: add homepage [`bd7917b`](https://github.com/KristjanTammekivi/hein/commit/bd7917b65bf68a71e73afe90e9ea855c2e1c0baf)
+
 #### [hein@1.2.3](https://github.com/KristjanTammekivi/hein/compare/hein@1.2.2...hein@1.2.3)
 
 > 5 July 2023
 
 - feat: add roundTo [`f9bb073`](https://github.com/KristjanTammekivi/hein/commit/f9bb0739b798861e506311a3ba55eb4fd3ac5920)
+- style: remove unused export [`256de45`](https://github.com/KristjanTammekivi/hein/commit/256de455ce7eeff35049d72bc80043db06a68f0c)
 
 #### [hein@1.2.2](https://github.com/KristjanTammekivi/hein/compare/hein@1.2.1...hein@1.2.2)
 

package/README.md

@@ -3,35 +3,36 @@
 [![npm](https://img.shields.io/npm/v/hein?style=flat-square)](https://www.npmjs.com/package/hein)
 [![npm](https://img.shields.io/npm/types/hein?style=flat-square)](https://www.npmjs.com/package/hein)
 [![npm](https://img.shields.io/npm/dw/hein?style=flat-square)](https://www.npmjs.com/package/hein)
-[![npm](https://img.shields.io/github/workflow/status/KristjanTammekivi/hein/Build,%20Lint,%20and%20Test/main?style=flat-square)](https://www.npmjs.com/package/hein)
+[![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/KristjanTammekivi/hein/build_lint_and_test.yml?style=flat-square)](https://www.npmjs.com/package/hein)
 
 Assertion library with focus on TypeScript
 
-## Features?
+## Features
 
-* Full TypeScript support
-* Fuzzy matching for eql with hein.any
+-   Full TypeScript support
+-   Fuzzy matching for eql with hein.any
 
-* [Differences between Chai and Hein](https://github.com/KristjanTammekivi/hein/blob/main/packages/hein/DIFFERENCES_WITH_CHAI.md)
+-   [Differences between Chai and Hein](https://github.com/KristjanTammekivi/hein/blob/main/packages/hein/DIFFERENCES_WITH_CHAI.md)
 
 ## Plugins
 
 [npm/hein-plugin-sinon](https://www.npmjs.com/package/hein-plugin-sinon) -
 Provides assertions like to.have.been.calledOnce() and to.have.been.calledWith() for sinon spies.
 
-
 ## Usage
 
 ### Assert
+
 ```typescript
 import { assert } from 'hein';
-import {equal} from 'hein/assert';
+import { equal } from 'hein/assert';
 
 equal(1, 1);
 assert.equal(1, 1);
 ```
 
 ### Expect
+
 ```typescript
 import { expect } from 'hein';
 expect(1).to.equal(1);
@@ -39,13 +40,13 @@ expect(1).to.equal(1);
 
 #### Chainable properties
 
-* a
-* an
-* and - used to chain multiple assertions, clears the state (so .not will be reset)
-* be
-* have
-* not - inverts the expectation (ie `expect(5).to.not.equal(5)` will throw)
-* to
+-   a
+-   an
+-   and - used to chain multiple assertions, clears the state (so .not will be reset)
+-   be
+-   have
+-   not - inverts the expectation (ie `expect(5).to.not.equal(5)` will throw)
+-   to
 
 #### Assertions
 
@@ -72,6 +73,7 @@ Alias for [lessThanOrEqual](#lessThanOrEqual)
 ##### ballpark
 
 Assert that value is within a range of expectation (default is 0.1 - within 10%)
+
 ```typescript
 expect(1.1).to.be.in.ballpark(1);
 expect(120).to.be.in.ballpark(100, 0.2);
@@ -106,12 +108,13 @@ Alias for [include](#include)
 Assert that value is an instance of Date
 
 ```typescript
-expect(new Date).to.be.a.date();
+expect(new Date()).to.be.a.date();
 ```
 
 ##### empty
 
 Assert that array / object / Map / Set is empty
+
 ```typescript
 expect([]).to.be.empty();
 expect({}).to.be.empty();
@@ -122,6 +125,7 @@ expect(new Set()).to.be.empty();
 ##### endWith
 
 Assert that string ends with argument
+
 ```typescript
 expect('hein').to.endWith('in');
 ```
@@ -129,17 +133,17 @@ expect('hein').to.endWith('in');
 ##### eql
 
 Assert that value deep equals the expectation. When combined with .partially expected may have missing properties
+
 ```typescript
 expect({ a: 1 }).to.eql({ a: 1 });
-expect({ a: 1, b: new Date()}).to.partially.eql({ a: 1 });
+expect({ a: 1, b: new Date() }).to.partially.eql({ a: 1 });
 
 import { any, createEvaluation } from 'hein';
 expect({ a: 1, b: new Date(), c: Math.random() }).to.eql({
     a: 1,
     b: any,
-    c: createEvaluation(n => typeof n === 'number')
+    c: createEvaluation((n) => typeof n === 'number')
 });
-
 ```
 
 ##### eq
@@ -150,15 +154,17 @@ Alias for [equal](#equal)
 
 Assert that value strictly equals expectation. NaN is treated as a non-unique value.
 Chaining with .deep is an alias for [#eql]
+
 ```typescript
 expect('hein').to.equal('hein');
 expect(NaN).to.equal(NaN);
-expect({ a: 1 }).to.deep.equal({ a: 1 })
+expect({ a: 1 }).to.deep.equal({ a: 1 });
 ```
 
 ##### false
 
 Assert that value is false
+
 ```typescript
 expect(false).to.be.false();
 ```
@@ -166,6 +172,7 @@ expect(false).to.be.false();
 ##### function
 
 Assert that value is a function
+
 ```typescript
 expect(() => {}).to.be.a.function();
 ```
@@ -173,6 +180,7 @@ expect(() => {}).to.be.a.function();
 ##### greaterThan
 
 Assert that value is greater than expectation
+
 ```typescript
 expect(5).to.be.greaterThan(4);
 ```
@@ -184,6 +192,7 @@ Alias for [greaterThan](#greaterThan)
 ##### greaterThanOrEqual
 
 Assert that value is greater than or equal to argument
+
 ```typescript
 expect(5).to.be.greaterThanOrEqual(5);
 expect(5).to.be.greaterThanOrEqual(4);
@@ -196,6 +205,7 @@ Alias for [greaterThanOrEqual](#greaterThanOrEqual)
 ##### include
 
 Assert that element / substring is present in array / string
+
 ```typescript
 expect([1, 2, 3]).to.include(2);
 expect('hein').to.include('ei');
@@ -204,6 +214,7 @@ expect('hein').to.include('ei');
 ##### instanceOf
 
 Assert that value is an instance of provided constructor
+
 ```typescript
 expect(new Error()).to.be.an.instanceOf(Error);
 ```
@@ -211,6 +222,7 @@ expect(new Error()).to.be.an.instanceOf(Error);
 ##### lengthOf
 
 Assert that value has a length equal to argument
+
 ```typescript
 expect([1]).to.have.a.lengthOf(1);
 expect({ a: 1 }).to.have.a.lengthOf(1);
@@ -222,6 +234,7 @@ expect('hein').to.have.a.lengthOf(4);
 ##### isAfter
 
 Assert that date is before argument
+
 ```typescript
 expect(new Date(2020, 1, 2)).to.be.after(new Date(2020, 1, 1));
 ```
@@ -229,6 +242,7 @@ expect(new Date(2020, 1, 2)).to.be.after(new Date(2020, 1, 1));
 ##### isBefore
 
 Assert that date is before argument
+
 ```typescript
 expect(new Date(2020, 1, 1)).to.be.before(new Date(2020, 1, 2));
 ```
@@ -236,6 +250,7 @@ expect(new Date(2020, 1, 1)).to.be.before(new Date(2020, 1, 2));
 ##### isBetween
 
 Assert that date or number is between arguments
+
 ```typescript
 expect(new Date(2020, 1, 2)).to.be.between(new Date(2020, 1, 1), new Date(2020, 1, 3));
 expect(2).to.be.between(1, 3);
@@ -244,9 +259,11 @@ expect(2).to.be.between(1, 3);
 ##### lessThan
 
 Assert that value is less than expectation
+
 ```typescript
 expect(5).to.be.lessThan(6);
 ```
+
 ##### lt
 
 Alias for [lessThan](#lessThan)
@@ -254,6 +271,7 @@ Alias for [lessThan](#lessThan)
 ##### lessThanOrEqual
 
 Assert that value is less than or equal to expectation
+
 ```typescript
 expect(5).to.be.lessThanOrEqual(5);
 expect(4).to.be.lessThanOrEqual(5);
@@ -266,13 +284,31 @@ Alias for [lessThanOrEqual](#lessThanOrEqual)
 ##### Map
 
 Assert that value is an instance of Map
+
 ```typescript
 expect(new Map()).to.be.a.Map();
 ```
 
+##### members
+
+Assert that array contains members of expectation
+
+```typescript
+expect([1, 2, 3]).to.have.members([1, 2]);
+// check that the arrays have same length
+expect([1, 2, 3]).to.have.same.members([1, 2, 3]);
+// check that the members are found in the same order
+expect([1, 2, 3]).to.have.ordered.members([1, 2, 3]);
+// check for deep equality of members
+expect([{ a: 1 }, { b: 2 }]).to.have.deep.members([{ a: 1 }]);
+// check for members by partial equality
+expect([{ a: 1 }, { b: 2 }]).to.have.partially.members([{ a: 1 }]);
+```
+
 ##### NaN
 
 Assert that value is NaN
+
 ```typescript
 expect(NaN).to.be.NaN();
 ```
@@ -280,6 +316,7 @@ expect(NaN).to.be.NaN();
 ##### null
 
 Assert that value is null
+
 ```typescript
 expect(null).to.be.null();
 ```
@@ -287,6 +324,7 @@ expect(null).to.be.null();
 ##### number
 
 Assert that value is a number
+
 ```typescript
 expect(5).to.be.a.number();
 ```
@@ -294,6 +332,7 @@ expect(5).to.be.a.number();
 ##### object
 
 Assert that value is an object. Null and instances of Array don't count
+
 ```typescript
 expect({}).to.be.an.object();
 ```
@@ -301,6 +340,7 @@ expect({}).to.be.an.object();
 ##### property
 
 Assert that actual has property. Optionally check that propery has value
+
 ```typescript
 expect({ a: 1 }).to.have.property('a');
 expect({ a: 1 }).to.have.property('a', 1);
@@ -309,6 +349,7 @@ expect({ a: 1 }).to.have.property('a', 1);
 ##### reject
 
 Assert that provided Promise rejects. At the moment this is the only assertion that can't be chained, returns a promise
+
 ```typescript
 await expect(Promise.reject()).to.reject();
 ```
@@ -316,6 +357,7 @@ await expect(Promise.reject()).to.reject();
 ##### roundTo
 
 Assert that number can be rounded to target
+
 ```typescript
 expect(5.5).to.be.roundTo(6);
 expect(5.14).to.roundTo(5.1, 1);
@@ -325,17 +367,19 @@ expect(110).to.roundTo(100, -2);
 ##### Set
 
 Assert that value is an instance of Set
+
 ```typescript
 expect(new Set()).to.be.a.Set();
 ```
+
 ##### sizeOf
 
 Alias of [lengthOf](#lengthOf)
 
-
 ##### startWith
 
 Assert that string starts with argument
+
 ```typescript
 expect('hein').to.startWith('he');
 ```
@@ -343,6 +387,7 @@ expect('hein').to.startWith('he');
 ##### string
 
 Assert that value is a string
+
 ```typescript
 expect('hein').to.be.a.string();
 ```
@@ -350,6 +395,7 @@ expect('hein').to.be.a.string();
 ##### symbol
 
 Assert that value is a symbol
+
 ```typescript
 expect(Symbol()).to.be.a.symbol();
 ```
@@ -357,12 +403,17 @@ expect(Symbol()).to.be.a.symbol();
 ##### throw
 
 Assert that provided function throws
+
 ```typescript
-expect(() => { throw new Error() }).to.throw();
+expect(() => {
+    throw new Error();
+}).to.throw();
 ```
+
 ##### true
 
 Assert that value is true
+
 ```typescript
 expect(true).to.be.true;
 ```
@@ -370,6 +421,7 @@ expect(true).to.be.true;
 ##### undefined
 
 Assert that value is undefined
+
 ```typescript
 expect(undefined).to.be.undefined();
 ```
@@ -377,6 +429,7 @@ expect(undefined).to.be.undefined();
 ##### WeakMap
 
 Assert that value is an instance of WeakMap
+
 ```typescript
 expect(new WeakMap()).to.be.a.WeakMap();
 ```
@@ -384,6 +437,7 @@ expect(new WeakMap()).to.be.a.WeakMap();
 ##### WeakSet
 
 Assert that value is an instance of WeakSet
+
 ```typescript
 expect(new WeakSet()).to.be.a.WeakSet();
 ```
@@ -393,6 +447,7 @@ expect(new WeakSet()).to.be.a.WeakSet();
 ##### excluding
 
 Exclude properties from assertion
+
 ```typescript
 expect({ a: 1, b: 2 }).excluding('a').to.eql({ b: 2 });
 ```