DefinitelyTyped/types/chai-arrays/index.d.ts
Rebecca Turner 12453a8fe1 [chai] Provide type definitions for chai.use (#37451)
* chai: Add types for chai.use and chai.util

Helps developers write Chai plugins; requested in #29922.

Closes #29922.

* Updated dependencies on Chai

- Minimum TS version: 3.0
    - Version bumps to TS 3.0 for the following type definitions which
      depend on chai directly or indirectly:
            bardjs, chai, chai-almost, chai-arrays, chai-as-promised,
            chai-datetime, chai-dom, chai-enzyme, chai-fs, chai-fuzzy,
            chai-jest-snapshot, chai-jquery, chai-json-schema,
            chai-moment, chai-oequal, chai-roughly, chai-spies,
            chai-string, chai-subset, chai-things, chai-uuid,
            chai-webdriverio, chai-xml, d3kit, deep-equal-in-any-order,
            dirty-chai, ember-mocha, hexo, hexo-log, hexo-util,
            jsx-chai, karma-chai, karma-chai-sinon, redux-test-utils,
            and sinon-chai
- Use Chai.ChaiPlugin instead of (chai: any, utils: any) => void

* Factor out pathval types

- Forgot that the pathval types aren't merged yet

* Factor out pathval types

- Forgot that the pathval types aren't merged yet

* Make 'chainingBehavior' non-mandatory
2019-08-08 08:58:47 -07:00

35 lines
1.3 KiB
TypeScript

// Type definitions for chai-arrays 1.0
// Project: https://github.com/GaneshSPatil/chai-arrays
// Definitions by: Clément Prévot <https://github.com/clementprevot>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 3.0
/// <reference types="chai" />
declare global {
namespace Chai {
interface Assertion extends LanguageChains, NumericComparison, TypeComparison {
array(): Assertion;
ofSize(size: number): Assertion;
equalTo(arr: any[]): Assertion;
containing(value: any): Assertion;
containingAllOf(values: any[]): Assertion;
containingAnyOf(values: any[]): Assertion;
sorted(): Assertion;
}
interface Assert {
array(val: any[], msg?: string): void;
ofSize(val: any[], size: number, msg?: string): void;
equalTo(val: any[], array: any[], msg?: string): void;
containing(val: any[], value: any, msg?: string): void;
containingAllOf(val: any[], values: any[], msg?: string): void;
containingAnyOf(val: any[], values: any[], msg?: string): void;
sorted(val: any[], msg?: string): void;
}
}
}
declare const chaiArrays: Chai.ChaiPlugin;
export = chaiArrays;