Add note explaining Draft type

immerjs · Aug 15, 2022 · 8643945 · 8643945
1 parent e28b53f
commit 8643945
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/src/types/types-external.ts b/src/types/types-external.ts
@@ -32,6 +32,7 @@ type WeakReferences = IfAvailable<WeakMap<any, any>> | IfAvailable<WeakSet<any>>
 
 export type WritableDraft<T> = {-readonly [K in keyof T]: Draft<T[K]>}
 
+/** Convert a readonly type into a mutable type, if possible */
 export type Draft<T> = T extends PrimitiveType
 	? T
 	: T extends AtomicObject