chai-assert.d.ts

// Type definitions for chai v1.7.0 assert style
// Project: http://chaijs.com/
// Definitions by: Bart van der Schoor <https://github.com/Bartvds>
// Definitions: https://github.com/borisyankov/DefinitelyTyped

declare module chai
{
	interface Assert
	{
		(express:any, msg?:string):void;

		fail(actual?:any, expected?:any, msg?:string, operator?:string):void;

		ok(val:any, msg?:string):void;
		notOk(val:any, msg?:string):void;

		equal(act:any, exp:any, msg?:string):void;
		notEqual(act:any, exp:any, msg?:string):void;

		strictEqual(act:any, exp:any, msg?:string):void;
		notStrictEqual(act:any, exp:any, msg?:string):void;

		deepEqual(act:any, exp:any, msg?:string):void;
		notDeepEqual(act:any, exp:any, msg?:string):void;

		isTrue(val:any, msg?:string):void;
		isFalse(val:any, msg?:string):void;

		isNull(val:any, msg?:string):void;
		isNotNull(val:any, msg?:string):void;

		isUndefined(val:any, msg?:string):void;
		isDefined(val:any, msg?:string):void;

		isFunction(val:any, msg?:string):void;
		isNotFunction(val:any, msg?:string):void;

		isObject(val:any, msg?:string):void;
		isNotObject(val:any, msg?:string):void;

		isArray(val:any, msg?:string):void;
		isNotArray(val:any, msg?:string):void;

		isString(val:any, msg?:string):void;
		isNotString(val:any, msg?:string):void;

		isNumber(val:any, msg?:string):void;
		isNotNumber(val:any, msg?:string):void;

		isBoolean(val:any, msg?:string):void;
		isNotBoolean(val:any, msg?:string):void;

		typeOf(val:any, type:string, msg?:string):void;
		notTypeOf(val:any, type:string, msg?:string):void;

		instanceOf(val:any, type:Function, msg?:string):void;
		notInstanceOf(val:any, type:Function, msg?:string):void;

		include(exp:string, inc:any, msg?:string):void;
		include(exp:any[], inc:any, msg?:string):void;

		notInclude(exp:string, inc:any, msg?:string):void;
		notInclude(exp:any[], inc:any, msg?:string):void;

		match(exp:any, re:RegExp, msg?:string):void;
		notMatch(exp:any, re:RegExp, msg?:string):void;

		property(obj:Object, prop:string, msg?:string):void;
		notProperty(obj:Object, prop:string, msg?:string):void;
		deepProperty(obj:Object, prop:string, msg?:string):void;
		notDeepProperty(obj:Object, prop:string, msg?:string):void;

		propertyVal(obj:Object, prop:string, val:any, msg?:string):void;
		propertyNotVal(obj:Object, prop:string, val:any, msg?:string):void;

		deepPropertyVal(obj:Object, prop:string, val:any, msg?:string):void;
		deepPropertyNotVal(obj:Object, prop:string, val:any, msg?:string):void;

		lengthOf(exp:any, len:number, msg?:string):void;

		//alias frenzy
		throw(fn:Function, msg?:string):void;
		throw(fn:Function, regExp:RegExp):void;
		throw(fn:Function, errType:Function, msg?:string):void;
		throw(fn:Function, errType:Function, regExp:RegExp):void;

		throws(fn:Function, msg?:string):void;
		throws(fn:Function, regExp:RegExp):void;
		throws(fn:Function, errType:Function, msg?:string):void;
		throws(fn:Function, errType:Function, regExp:RegExp):void;

		Throw(fn:Function, msg?:string):void;
		Throw(fn:Function, regExp:RegExp):void;
		Throw(fn:Function, errType:Function, msg?:string):void;
		Throw(fn:Function, errType:Function, regExp:RegExp):void;

		doesNotThrow(fn:Function, msg?:string):void;
		doesNotThrow(fn:Function, regExp:RegExp):void;
		doesNotThrow(fn:Function, errType:Function, msg?:string):void;
		doesNotThrow(fn:Function, errType:Function, regExp:RegExp):void;

		operator(val:any, operator:string, val2:any, msg?:string):void;
		closeTo(act:number, exp:number, delta:number, msg?:string):void;

		sameMembers(set1:any[], set2:any[], msg?:string):void;
		includeMembers(set1:any[], set2:any[], msg?:string):void;

		ifError(val:any, msg?:string):void;
	}
	//node module
	var assert:Assert;
}
//browser global
declare var assert:chai.Assert;