DefinitelyTyped/types/chai-jest-snapshot/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

41 lines
1.2 KiB
TypeScript

// Type definitions for chai-jest-snapshot 1.3
// Project: https://github.com/suchipi/chai-jest-snapshot#readme
// Definitions by: Matt Perry <https://github.com/mattvperry>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 3.0
/// <reference types="chai" />
/// <reference types="mocha" />
declare global {
namespace Chai {
interface Assertion {
/** Assert that the object matches the snapshot */
matchSnapshot(snapshotFilename?: string, snapshotName?: string, update?: boolean): Assertion;
matchSnapshot(update: boolean): Assertion;
}
}
}
interface ChaiJestSnapshot extends Chai.ChaiPlugin {
/** Set snapshot file name */
setFilename(filename: string): void;
/**
* Set snapshot test name
*/
setTestName(testname: string): void;
/** Configure snapshot name using mocha context */
configureUsingMochaContext(context: Mocha.IBeforeAndAfterContext): void;
/** Reset snapshot registry */
resetSnapshotRegistry(): void;
/** Add a serializer plugin */
addSerializer(serializer: any): void;
}
declare var ChaiJestSnapshot: ChaiJestSnapshot;
export = ChaiJestSnapshot;