TS Error: finishDraft Expected 2 arguments, but got 1.

[eddyw]

🐛 Bug Report

TS complains that the second argument for finishDraft is required.

To Reproduce

const final = finishDraft(draft)

Observed behavior

Our build started to fail with latest version of immer:

TS2554: Expected 2 arguments, but got 1.

96     const cssAttributesFinal = finishDraft(cssAttributes)
                                  ~~~~~~~

And it's everywhere. There is no update in the docs that the patch listener has become a required argument, so I think this is a bug with typings of the function.

Expected behavior

The second argument for finishDraft should be optional.

Environment

• Immer version: 5.0.1

[mweststrate]

This is definitely not intended indeed. Feel free to // @ts-ignore until fixed Op ma 23 dec. 2019 11:30 schreef Eddy Wilson <[email protected]>:

…

🐛 Bug Report TS complains that the second argument for finishDraft is required. To Reproduce const final = finishDraft(draft) Observed behavior Our build started to fail with latest version of immer: TS2554: Expected 2 arguments, but got 1. 96 const cssAttributesFinal = finishDraft(cssAttributes) ~~~~~~~ And it's everywhere. There is no update in the docs that the patch listener has become a required argument, so I think this is a bug with typings of the function. Expected behavior The second argument for finishDraft should be optional. Environment - *Immer version: 5.0.1* — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#492?email_source=notifications&email_token=AAN4NBCVYEKE4LNFTXTGOMDQ2CHNZA5CNFSM4J6SQMTKYY3PNVWWK3TUL52HS4DFUVEXG43VMWVGG33NNVSW45C7NFSM4ICJRJHQ>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAN4NBHPMVLL65NXAMUF2DTQ2CHNZANCNFSM4J6SQMTA> .

[CGamesPlay]

To save anyone who investigates this some time, the following is not a valid fix. You would think this would work, however after applying this patch, immer.d.ts is correct, however index.d.ts file ends up incorrect.

diff --git i/src/immer.ts w/src/immer.ts
index a6d94cf..6457493 100644
--- i/src/immer.ts
+++ w/src/immer.ts
@@ -178,7 +178,7 @@ export class Immer implements ProducersFns {
 		return proxy as any
 	}
 
-	finishDraft<D extends Draft<any>>(draft: D, patchListener: PatchListener): D extends Draft<infer T> ? T : never {
+	finishDraft<D extends Draft<any>>(draft: D, patchListener?: PatchListener): D extends Draft<infer T> ? T : never {
 		const state = draft && draft[DRAFT_STATE]
 		if (!state || !state.isManual) {
 			throw new Error("First argument to `finishDraft` must be a draft returned by `createDraft`") // prettier-ignore
diff --git i/src/scope.ts w/src/scope.ts
index 4436fea..72d185f 100644
--- i/src/scope.ts
+++ w/src/scope.ts
@@ -24,7 +24,7 @@ export class ImmerScope {
 		this.patches = null as any // TODO:
 	}
 
-	usePatches(patchListener: PatchListener) {
+	usePatches(patchListener?: PatchListener) {
 		if (patchListener) {
 			this.patches = []
 			this.inversePatches = []

This results in an index.d.ts that looks like this:

export declare const finishDraft: <D extends any>(draft: D, patchListener: import("./types").PatchListener | undefined) => D extends import("./types").Draft<infer T> ? T : never;

[aleclarson]

🎉 This issue has been resolved in version 5.2.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀