hamjest 3.6.2 → 3.7.3

package/@types/index.d.ts

@@ -2,7 +2,7 @@ declare module 'hamjest' {
 	type Value = any;
 
 	export class Matcher {
-		constructor(fns?: {matches?: (Value) => boolean; describeTo?: (Description) => void; describeMismatch?: (Value, Description) => void});
+		constructor(fns?: {matches?: (value: Value) => boolean; describeTo?: (description: Description) => void; describeMismatch?: (value: Value, description: Description) => void});
 		matches(actual: Value): boolean;
 		describeTo(description: Description): void;
 		describeMismatch(value: Value, description: Description): void;
@@ -11,7 +11,7 @@ declare module 'hamjest' {
 	type ValueOrMatcher = Value | Matcher;
 
 	export class TypeSafeMatcher<T> extends Matcher {
-		constructor(fns?: {isExpectedType?: (Value) => boolean; matchesSafely?: (T) => boolean; describeTo?: (Description) => void; describeMismatchSafely?: (T, Description) => void});
+		constructor(fns?: {isExpectedType?: (value: Value) => boolean; matchesSafely?: (actual: T) => boolean; describeTo?: (description: Description) => void; describeMismatchSafely?: (value: T, description: Description) => void});
 		isExpectedType(actual: Value): boolean;
 		matchesSafely(actual: T): boolean;
 		describeMismatchSafely(value: T, description: Description): void;
@@ -33,8 +33,8 @@ declare module 'hamjest' {
 		get(): string;
 	}
 
-	export function assertThat(actual: Value, matcher: Matcher): void;
-	export function assertThat(reason: string, actual: Value, matcher: Matcher): void;
+	export function assertThat(actual: Value, matcher: ValueOrMatcher): void;
+	export function assertThat(reason: string, actual: Value, matcher: ValueOrMatcher): void;
 
 	export function promiseThat(actual: Promise<Value>, matcher: Matcher): Promise<any>;
 	export function promiseThat(reason: string, actual: Promise<Value>, matcher: Matcher): Promise<any>;
@@ -187,7 +187,7 @@ declare module 'hamjest' {
 	export function orderedBy(comparisonFunction: (a: Value, b: Value) => boolean, orderName?: string): TypeSafeMatcher<Array<any>>;
 
 	// hasSize: require('./matchers/hasSize'),;
-	export function hasSize(size: number): Matcher;
+	export function hasSize(size: ValueOrMatcher): Matcher;
 
 	// isEmpty: require('./matchers/isEmpty'),;
 	export function isEmpty(): Matcher;

package/@types/typeTests.ts

@@ -8,6 +8,8 @@ __.assertThat(2, __.not(__.equalTo(1)));
 __.assertThat(2, __.is(__.not(1)));
 __.assertThat(2, __.is(__.not(__.equalTo(1))));
 __.assertThat(2, __.is(__.not(__.equalTo(1))));
+__.assertThat({one: 1}, {one: 1});
+__.assertThat('a reason', {one: 1}, {one: 1});
 
 // Primitives
 __.assertThat(true, __.truthy());
@@ -52,6 +54,7 @@ __.assertThat(new Date('2015-06-01T14:00:00'), __.beforeOrEqualTo(new Date('2015
 
 // Array matcher
 __.assertThat([1, 2, 3], __.hasSize(3));
+__.assertThat([1, 2, 3], __.hasSize(__.greaterThan(2)));
 __.assertThat([], __.isEmpty());
 __.assertThat([], __.empty());
 __.assertThat([1], __.hasExactlyOneItem(1));

package/README.md

@@ -30,17 +30,26 @@ npm install hamjest --save-dev
 All asserts and matchers are available as children of the `hamjest` module, so just require it, give it an unobtrusive name and start matching:
 
 ```JavaScript
-var __ = require('hamjest');
+const __ = require('hamjest');
 	
 __.assertThat('jim the rat', __.containsString('rat'));
 __.assertThat(5, __.is(__.greaterThan(2)));
 __.assertThat([5, 12, 9], __.hasItem(__.greaterThanOrEqualTo(11)));
 ```
 
+If you’re a TypeScript fan, you can use that as well:
+```TypeScript
+// You can use destructuring imports if you like…
+import {assertThat, is, greaterThan} from 'hamjest';
+
+assertThat(42, is(greaterThan(21)));
+```
+
+
 The best thing about Hamjest are its error messages, just like the [Java original](http://hamcrest.org):
 
 ```JavaScript
-var sut = {name: 1337, age: 25};
+const sut = {name: 1337, age: 25};
 __.assertThat(sut, __.hasProperties({name: __.string(), age: __.greaterThan(18)}));
 
 AssertionError: 
@@ -60,7 +69,7 @@ Expected: a number less than <18>
 
 See the [matcher documentation](https://github.com/rluba/hamjest/wiki/Matcher-documentation) for a list of available matchers.
 
-Have a look at the [test suite](./test/) to see lots of usage examples [for each matcher](./test/matchers/) as well as the [assertThat](./test/assertThatSpec.js) and [promiseThat](./test/promiseThatSpec.js) functions.
+Have a look at the [test suite](./test/node/) to see lots of usage examples [for each matcher](./test/node/matchers/) as well as the [assertThat](./test/node/assertThatSpec.js) and [promiseThat](./test/node/promiseThatSpec.js) functions.
 
 See the [documentation about promises](https://github.com/rluba/hamjest/wiki/Hamjest-and-Promises) for details about using Hamjest with promises or asserting asynchronously.
 
@@ -85,7 +94,7 @@ function animalWithName(valueOrMatcher) {
 	return new __.FeatureMatcher(valueOrMatcher, 'animal with name', 'name');
 }
 
-var animal = {name: 'Bob', age: 12};
+const animal = {name: 'Bob', age: 12};
 __.assertThat(animal, __.is(animalWithName('Tom')));
 
 AssertionError: 
@@ -102,7 +111,7 @@ function animalWithNameLength(valueOrMatcher) {
 	});
 }
 
-var animal = {name: 'bob', age: 12};
+const animal = {name: 'bob', age: 12};
 __.assertThat(animal, __.is(animalWithNameLength(__.greaterThan(5))));
 
 AssertionError: 
@@ -123,7 +132,7 @@ Simply include `dist/hamjest(.min).js` in your browser tests. It comes with "bat
 The browser build exports a single global: `hamjest`. You can rename it as usual for better readability:
 
 ```JavaScript
-var __ = hamjest;
+const __ = hamjest;
 
 __.assertThat('2007-05-01', __.startsWith('2007'));
 ```