docs(api): update api docs

unadlib · unadlib · commit 398c5a545608 · 2024-11-22T23:45:43.000+08:00
diff --git a/README.md b/README.md
@@ -533,6 +533,7 @@ expect(state.simpleObject).not.toBe(baseState.simpleObject);
 
 - `castDraft()`
 - `castImmutable()`
+- `castMutable()`
 - `Draft<T>`
 - `Immutable<T>`
 - `Patches`
diff --git a/docs/README.md b/docs/README.md
@@ -21,6 +21,7 @@
 - [apply](functions/apply.md)
 - [castDraft](functions/castDraft.md)
 - [castImmutable](functions/castImmutable.md)
+- [castMutable](functions/castMutable.md)
 - [create](functions/create.md)
 - [current](functions/current.md)
 - [isDraft](functions/isDraft.md)
diff --git a/docs/functions/apply.md b/docs/functions/apply.md
@@ -48,4 +48,4 @@ expect(state).toEqual(apply(baseState, patches));
 
 ## Defined in
 
-[apply.ts:26](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/apply.ts#L26)
+[apply.ts:26](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/apply.ts#L26)
diff --git a/docs/functions/castDraft.md b/docs/functions/castDraft.md
@@ -24,4 +24,4 @@ Cast a value to an Draft type value.
 
 ## Defined in
 
-[utils/cast.ts:6](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/utils/cast.ts#L6)
+[utils/cast.ts:6](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/utils/cast.ts#L6)
diff --git a/docs/functions/castImmutable.md b/docs/functions/castImmutable.md
@@ -24,4 +24,4 @@ Cast a value to an Immutable type value.
 
 ## Defined in
 
-[utils/cast.ts:13](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/utils/cast.ts#L13)
+[utils/cast.ts:13](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/utils/cast.ts#L13)
diff --git a/docs/functions/castMutable.md b/docs/functions/castMutable.md
@@ -0,0 +1,27 @@
+[**mutative**](../README.md) • **Docs**
+
+***
+
+[mutative](../README.md) / castMutable
+
+# Function: castMutable()
+
+> **castMutable**\<`T`\>(`draft`): `T`
+
+Cast a value to an Mutable type value.
+
+## Type Parameters
+
+• **T**
+
+## Parameters
+
+• **draft**: [`Draft`](../type-aliases/Draft.md)\<`T`\>
+
+## Returns
+
+`T`
+
+## Defined in
+
+[utils/cast.ts:20](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/utils/cast.ts#L20)
diff --git a/docs/functions/create.md b/docs/functions/create.md
@@ -76,7 +76,7 @@ expect(state.arr).toBe(baseState.arr);
 
 ### Defined in
 
-[create.ts:25](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/create.ts#L25)
+[create.ts:25](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/create.ts#L25)
 
 ## create(base, mutate, options)
 
@@ -127,7 +127,7 @@ expect(state.arr).toBe(baseState.arr);
 
 ### Defined in
 
-[create.ts:25](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/create.ts#L25)
+[create.ts:25](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/create.ts#L25)
 
 ## create(mutate, options)
 
@@ -188,11 +188,11 @@ expect(state.arr).toBe(baseState.arr);
 
 ### Defined in
 
-[create.ts:25](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/create.ts#L25)
+[create.ts:25](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/create.ts#L25)
 
 ## create(base, options)
 
-> **create**\<`T`, `O`, `F`\>(`base`, `options`?): [`T`, () => `Result`\<`T`, `O`, `F`\>]
+> **create**\<`T`, `O`, `F`\>(`base`, `options`?): [[`Draft`](../type-aliases/Draft.md)\<`T`\>, () => `Result`\<`T`, `O`, `F`\>]
 
 `create(baseState, callback, options)` to create the next state
 
@@ -231,8 +231,8 @@ expect(state.arr).toBe(baseState.arr);
 
 ### Returns
 
-[`T`, () => `Result`\<`T`, `O`, `F`\>]
+[[`Draft`](../type-aliases/Draft.md)\<`T`\>, () => `Result`\<`T`, `O`, `F`\>]
 
 ### Defined in
 
-[create.ts:25](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/create.ts#L25)
+[create.ts:25](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/create.ts#L25)
diff --git a/docs/functions/current.md b/docs/functions/current.md
@@ -6,6 +6,8 @@
 
 # Function: current()
 
+## current(target)
+
 > **current**\<`T`\>(`target`): `T`
 
 `current(draft)` to get current state in the draft mutation function.
@@ -25,18 +27,42 @@ const state = create(
 );
 ```
 
-## Type Parameters
+### Type Parameters
+
+• **T** *extends* `object`
+
+### Parameters
+
+• **target**: [`Draft`](../type-aliases/Draft.md)\<`T`\>
+
+### Returns
+
+`T`
+
+### Defined in
+
+[current.ts:120](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/current.ts#L120)
+
+## current(target)
+
+> **current**\<`T`\>(`target`): `T`
+
+### Type Parameters
 
 • **T** *extends* `object`
 
-## Parameters
+### Parameters
 
 • **target**: `T`
 
-## Returns
+### Returns
 
 `T`
 
-## Defined in
+### Deprecated
+
+You should call current only on `Draft<T>` types.
+
+### Defined in
 
-[current.ts:104](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/current.ts#L104)
+[current.ts:122](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/current.ts#L122)
diff --git a/docs/functions/isDraft.md b/docs/functions/isDraft.md
@@ -20,4 +20,4 @@ Check if the value is a draft
 
 ## Defined in
 
-[utils/draft.ts:11](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/utils/draft.ts#L11)
+[utils/draft.ts:12](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/utils/draft.ts#L12)
diff --git a/docs/functions/isDraftable.md b/docs/functions/isDraftable.md
@@ -24,4 +24,4 @@ Check if a value is draftable
 
 ## Defined in
 
-[utils/draft.ts:28](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/utils/draft.ts#L28)
+[utils/draft.ts:29](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/utils/draft.ts#L29)
diff --git a/docs/functions/makeCreator.md b/docs/functions/makeCreator.md
@@ -6,7 +6,7 @@
 
 # Function: makeCreator()
 
-> **makeCreator**\<`_F`, `_O`\>(`options`?): \<`T`, `F`, `O`, `R`\>(`base`, `mutate`, `options`?) => `CreateResult`\<`T`, `O`, `F`, `R`\>\<`T`, `F`, `O`, `R`\>(`base`, `mutate`, `options`?) => `CreateResult`\<`T`, `O`, `F`, `R`\>\<`T`, `P`, `F`, `O`, `R`\>(`mutate`, `options`?) => (`base`, ...`args`) => `CreateResult`\<`T`, `O`, `F`, `R`\>\<`T`, `O`, `F`\>(`base`, `options`?) => [`T`, () => `Result`\<`T`, `O`, `F`\>]
+> **makeCreator**\<`_F`, `_O`\>(`options`?): \<`T`, `F`, `O`, `R`\>(`base`, `mutate`, `options`?) => `CreateResult`\<`T`, `O`, `F`, `R`\>\<`T`, `F`, `O`, `R`\>(`base`, `mutate`, `options`?) => `CreateResult`\<`T`, `O`, `F`, `R`\>\<`T`, `P`, `F`, `O`, `R`\>(`mutate`, `options`?) => (`base`, ...`args`) => `CreateResult`\<`T`, `O`, `F`, `R`\>\<`T`, `O`, `F`\>(`base`, `options`?) => [[`Draft`](../type-aliases/Draft.md)\<`T`\>, () => `Result`\<`T`, `O`, `F`\>]
 
 `makeCreator(options)` to make a creator function.
 
@@ -137,8 +137,8 @@ expect(Object.isFrozen(state)).toBeTruthy();
 
 ### Returns
 
-[`T`, () => `Result`\<`T`, `O`, `F`\>]
+[[`Draft`](../type-aliases/Draft.md)\<`T`\>, () => `Result`\<`T`, `O`, `F`\>]
 
 ## Defined in
 
-[makeCreator.ts:87](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/makeCreator.ts#L87)
+[makeCreator.ts:87](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/makeCreator.ts#L87)
diff --git a/docs/functions/markSimpleObject.md b/docs/functions/markSimpleObject.md
@@ -18,4 +18,4 @@
 
 ## Defined in
 
-[utils/marker.ts:26](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/utils/marker.ts#L26)
+[utils/marker.ts:26](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/utils/marker.ts#L26)
diff --git a/docs/functions/original.md b/docs/functions/original.md
@@ -39,4 +39,4 @@ const state = create(
 
 ## Defined in
 
-[original.ts:21](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/original.ts#L21)
+[original.ts:21](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/original.ts#L21)
diff --git a/docs/functions/rawReturn.md b/docs/functions/rawReturn.md
@@ -39,4 +39,4 @@ expect(state).toBe(baseState);
 
 ## Defined in
 
-[rawReturn.ts:21](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/rawReturn.ts#L21)
+[rawReturn.ts:21](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/rawReturn.ts#L21)
diff --git a/docs/functions/unsafe.md b/docs/functions/unsafe.md
@@ -51,4 +51,4 @@ expect(state.foobar.bar).toBe(2);
 
 ## Defined in
 
-[unsafe.ts:53](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/unsafe.ts#L53)
+[unsafe.ts:53](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/unsafe.ts#L53)
diff --git a/docs/interfaces/Options.md b/docs/interfaces/Options.md
@@ -22,7 +22,7 @@ Enable autoFreeze, and return frozen state.
 
 #### Defined in
 
-[interface.ts:137](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/interface.ts#L137)
+[interface.ts:137](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/interface.ts#L137)
 
 ***
 
@@ -34,7 +34,7 @@ Enable patch, and return the patches and inversePatches.
 
 #### Defined in
 
-[interface.ts:133](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/interface.ts#L133)
+[interface.ts:133](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/interface.ts#L133)
 
 ***
 
@@ -47,7 +47,7 @@ And it can also return a shallow copy function(AutoFreeze and Patches should bot
 
 #### Defined in
 
-[interface.ts:142](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/interface.ts#L142)
+[interface.ts:142](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/interface.ts#L142)
 
 ***
 
@@ -59,4 +59,4 @@ In strict mode, Forbid accessing non-draftable values and forbid returning a non
 
 #### Defined in
 
-[interface.ts:129](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/interface.ts#L129)
+[interface.ts:129](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/interface.ts#L129)
diff --git a/docs/type-aliases/Draft.md b/docs/type-aliases/Draft.md
@@ -14,4 +14,4 @@
 
 ## Defined in
 
-[interface.ts:182](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/interface.ts#L182)
+[interface.ts:182](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/interface.ts#L182)
diff --git a/docs/type-aliases/Immutable.md b/docs/type-aliases/Immutable.md
@@ -14,4 +14,4 @@
 
 ## Defined in
 
-[interface.ts:164](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/interface.ts#L164)
+[interface.ts:164](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/interface.ts#L164)
diff --git a/docs/type-aliases/Patch.md b/docs/type-aliases/Patch.md
@@ -14,4 +14,4 @@
 
 ## Defined in
 
-[interface.ts:58](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/interface.ts#L58)
+[interface.ts:58](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/interface.ts#L58)
diff --git a/docs/type-aliases/Patches.md b/docs/type-aliases/Patches.md
@@ -14,4 +14,4 @@
 
 ## Defined in
 
-[interface.ts:72](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/interface.ts#L72)
+[interface.ts:72](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/interface.ts#L72)
diff --git a/docs/type-aliases/PatchesOptions.md b/docs/type-aliases/PatchesOptions.md
@@ -10,4 +10,4 @@
 
 ## Defined in
 
-[interface.ts:18](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/interface.ts#L18)
+[interface.ts:18](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/interface.ts#L18)
diff --git a/website/docs/advanced-guides/typescript.md b/website/docs/advanced-guides/typescript.md
@@ -10,6 +10,7 @@ Mutative support is built into the typescript types. You can use the `Draft<T>`
 
 - `castDraft()`
 - `castImmutable()`
+- `castMutable()`
 - `Draft<T>`
 - `Immutable<T>`
 - `Patches`

Original file line number	Diff line number	Diff line change
`@@ -48,4 +48,4 @@ expect(state).toEqual(apply(baseState, patches));`
`48`	`48`
`49`	`49`	`## Defined in`
`50`	`50`
`51`		`-[apply.ts:26](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/apply.ts#L26)`
	`51`	`+[apply.ts:26](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/apply.ts#L26)`
Original file line number	Diff line number	Diff line change
`@@ -24,4 +24,4 @@ Cast a value to an Draft type value.`
`24`	`24`
`25`	`25`	`## Defined in`
`26`	`26`
`27`		`-[utils/cast.ts:6](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/utils/cast.ts#L6)`
	`27`	`+[utils/cast.ts:6](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/utils/cast.ts#L6)`
Original file line number	Diff line number	Diff line change
`@@ -24,4 +24,4 @@ Cast a value to an Immutable type value.`
`24`	`24`
`25`	`25`	`## Defined in`
`26`	`26`
`27`		`-[utils/cast.ts:13](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/utils/cast.ts#L13)`
	`27`	`+[utils/cast.ts:13](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/utils/cast.ts#L13)`
Original file line number	Diff line number	Diff line change
`@@ -20,4 +20,4 @@ Check if the value is a draft`
`20`	`20`
`21`	`21`	`## Defined in`
`22`	`22`
`23`		`-[utils/draft.ts:11](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/utils/draft.ts#L11)`
	`23`	`+[utils/draft.ts:12](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/utils/draft.ts#L12)`
Original file line number	Diff line number	Diff line change
`@@ -24,4 +24,4 @@ Check if a value is draftable`
`24`	`24`
`25`	`25`	`## Defined in`
`26`	`26`
`27`		`-[utils/draft.ts:28](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/utils/draft.ts#L28)`
	`27`	`+[utils/draft.ts:29](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/utils/draft.ts#L29)`
Original file line number	Diff line number	Diff line change
`@@ -18,4 +18,4 @@`
`18`	`18`
`19`	`19`	`## Defined in`
`20`	`20`
`21`		`-[utils/marker.ts:26](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/utils/marker.ts#L26)`
	`21`	`+[utils/marker.ts:26](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/utils/marker.ts#L26)`
Original file line number	Diff line number	Diff line change
`@@ -39,4 +39,4 @@ const state = create(`
`39`	`39`
`40`	`40`	`## Defined in`
`41`	`41`
`42`		`-[original.ts:21](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/original.ts#L21)`
	`42`	`+[original.ts:21](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/original.ts#L21)`
Original file line number	Diff line number	Diff line change
`@@ -39,4 +39,4 @@ expect(state).toBe(baseState);`
`39`	`39`
`40`	`40`	`## Defined in`
`41`	`41`
`42`		`-[rawReturn.ts:21](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/rawReturn.ts#L21)`
	`42`	`+[rawReturn.ts:21](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/rawReturn.ts#L21)`
Original file line number	Diff line number	Diff line change
`@@ -51,4 +51,4 @@ expect(state.foobar.bar).toBe(2);`
`51`	`51`
`52`	`52`	`## Defined in`
`53`	`53`
`54`		`-[unsafe.ts:53](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/unsafe.ts#L53)`
	`54`	`+[unsafe.ts:53](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/unsafe.ts#L53)`
Original file line number	Diff line number	Diff line change
`@@ -14,4 +14,4 @@`
`14`	`14`
`15`	`15`	`## Defined in`
`16`	`16`
`17`		`-[interface.ts:182](https://github.com/unadlib/mutative/blob/4e5a64df3bd670123a9179420fc5820dbbf11915/src/interface.ts#L182)`
	`17`	`+[interface.ts:182](https://github.com/unadlib/mutative/blob/7129237bc42b8475743ffff427a1f8f85e8e1e51/src/interface.ts#L182)`