fix: createDraft should return Draft instead of Drafted. Fixes #512

immerjs · Jan 16, 2020 · 3f15d49 · 3f15d49
1 parent ef8990b
commit 3f15d49
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/__tests__/draft.ts b/__tests__/draft.ts
@@ -330,3 +330,8 @@ test("asDraft preserves a value", () => {
 	const x = {}
 	expect(castDraft(x)).toBe(x)
 })
+
+test("#512 createDraft creates a draft", () => {
+	const x = {y: 1}
+	assert(x, _ as Draft<{y: number}>)
+})
diff --git a/src/immer.ts b/src/immer.ts
@@ -177,15 +177,15 @@ export class Immer implements ProducersFns {
 		return [nextState, patches!, inversePatches!]
 	}
 
-	createDraft<T extends Objectish>(base: T): Drafted<T> {
+	createDraft<T extends Objectish>(base: T): Draft<T> {
 		if (!isDraftable(base)) {
 			throw new Error("First argument to `createDraft` must be a plain object, an array, or an immerable object") // prettier-ignore
 		}
 		const scope = ImmerScope.enter(this)
 		const proxy = this.createProxy(base, undefined)
 		proxy[DRAFT_STATE].isManual = true
 		scope.leave()
-		return proxy
+		return proxy as any
 	}
 
 	finishDraft<D extends Draft<any>>(