diff --git a/index.d.ts b/index.d.ts index d78c6cd..55cb175 100644 --- a/index.d.ts +++ b/index.d.ts @@ -1,13 +1,13 @@ /// type DiffOptions = { - expand?: boolean - colors?: boolean - contextLines?: number - stablePatchmarks?: boolean - aAnnotation?: string - bAnnotation?: string -} + expand?: boolean; + colors?: boolean; + contextLines?: number; + stablePatchmarks?: boolean; + aAnnotation?: string; + bAnnotation?: string; +}; declare namespace jest { interface Matchers { @@ -15,28 +15,46 @@ declare namespace jest { * Compare the difference between the actual in the `expect()` * vs the object inside `valueB` with some extra options. */ - toMatchDiffSnapshot(valueB: any, options?: DiffOptions, testName?: string): R + toMatchDiffSnapshot( + valueB: any, + options?: DiffOptions, + testName?: string + ): R; } } -declare module "snapshot-diff" { +interface Serializer { + test: (value: any) => boolean; + print: (value: any, _serializer?: Function) => string; + diffOptions: (valueA: any, valueB: any) => DiffOptions; +} + +declare module 'snapshot-diff' { interface SnapshotDiff { /** * Compare the changes from a, to b */ - (a: any, b: any, options?: DiffOptions): string + (a: any, b: any, options?: DiffOptions): string; /** * Allows you to pull out toMatchDiffSnapshot and * make it available via `expect.extend({ toMatchDiffSnapshot })`. */ - toMatchDiffSnapshot: jest.CustomMatcher + toMatchDiffSnapshot: jest.CustomMatcher; /** * By default Jest adds extra quotes around strings so it makes diff * snapshots of objects too noisy. To fix this – snapshot-diff comes * with custom serializer. */ - getSnapshotDiffSerializer: () => jest.SnapshotSerializerPlugin + getSnapshotDiffSerializer: () => jest.SnapshotSerializerPlugin; + /** + * Add new serializers for unsupported data types, or to set a different + * serializer for React components. If you want to keep the default React + * serializer in place, don't forget to add the default serializers to your + * list of serializers. + */ + setSerializers: (serializers: Array) => void; + defaultSerializers: Array; } - const diff: SnapshotDiff - export = diff + const diff: SnapshotDiff; + export = diff; }