Skip to content

Commit e96a11e

Browse files
committed
docs(website): update
1 parent 30b550e commit e96a11e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+208
-208
lines changed

website/blog/2020-08-09-reactant-a-framework-for-building-react-web-applications.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Reactant is a progressive framework. In the process of developing applications f
3030

3131
### Better Immutable State Management
3232

33-
React advocates immutable state type management, and Redux clearly fits this. But the fact is that simple mutation update operations like MobX are increasingly in line with current trends. Therefore Reactant provides a new immutable state management model based on Redux and Immer, which incorporates similar API elements of MobX. And more importantly, it still maintains the immutability of state.
33+
React advocates immutable state type management, and Redux clearly fits this. But the fact is that simple mutation update operations like MobX are increasingly in line with current trends. Therefore Reactant provides a new immutable state management model based on Redux and [Mutative](https://github.com/unadlib/mutative), which incorporates similar API elements of MobX. And more importantly, it still maintains the immutability of state.
3434

3535
```ts
3636
@injectable()
@@ -93,7 +93,7 @@ Reactant will do more features that improve the development experience.
9393

9494
### Benchmark Performance
9595

96-
In benchmark performance tests between Reactant and MobX+React, Reactant has the edge in startup time and derived computing, while MobX+React has the edge in value updates. And overall, the performance difference is not particularly significant. Because Reactant is based on Immer, Reactant also provides a performance-optimized solution when encountering a very few extreme performance bottlenecks.
96+
In benchmark performance tests between Reactant and MobX+React, Reactant has the edge in startup time and derived computing, while MobX+React has the edge in value updates. And overall, the performance difference is not particularly significant. Because Reactant is based on [Mutative](https://github.com/unadlib/mutative), Reactant also provides a performance-optimized solution when encountering a very few extreme performance bottlenecks.
9797

9898
Reactant is committed to maintaining good performance while continuing to build a productive React framework.
9999

website/blog/2021-10-03-how-to-make-web-application-support-multiple-browser-windows/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ With that, we can quickly turn SharedWorker mode into SharedTab mode.
252252

253253
### Transport/Performance
254254

255-
Since the client app only renders and receives synchronized state. So the client app keeps running smoothly when the size of each dispatch update state does not exceed 50M. reactant uses [Immer patch](https://immerjs.github.io/immer/patches/) to update, usually this patch will be very small and reactant also does DEV checking for patch minimization updates. In fact, in most scenarios, the patch will not be that large.
255+
Since the client app only renders and receives synchronized state. So the client app keeps running smoothly when the size of each dispatch update state does not exceed 50M. reactant uses [Mutative Patch](https://github.com/unadlib/mutative) to update, usually this patch will be very small and reactant also does DEV checking for patch minimization updates. In fact, in most scenarios, the patch will not be that large.
256256

257257
| Update state size | Volume of data | Deserialization |
258258
| ------------------------- | -------------- | --------------- |
@@ -388,7 +388,7 @@ But in terms of module model and shared model, reactant-share already provides a
388388

389389
reactant-share is a framework for building Shared Web Apps. But such a model is not free, and it will face performance issues with data transfer (The high maintenance cost of the SharedArrayBuffer has forced us to abandon it for now as well. In fact this is a problem caused by the fact that JS "multithreading" does not share memory efficiently).
390390

391-
Although Shared Web Apps lets the client App run in a render-only client thread, it introduces the additional overhead of synchronous state transfer. We must ensure that it is lightweight and efficient enough. While reactant-share does state patch based on Immer, it is always difficult to ensure that each patch is minimally updated.
391+
Although Shared Web Apps lets the client App run in a render-only client thread, it introduces the additional overhead of synchronous state transfer. We must ensure that it is lightweight and efficient enough. While reactant-share does state patch based on [Mutative](https://github.com/unadlib/mutative), it is always difficult to ensure that each patch is minimally updated.
392392

393393
reactant-share provides a development option `enablePatchesChecker`. In development mode, it is enabled by default. Any mutation operation that is not a valid mutation will be alerted, usually eliminating the alert, and reactant-share will try to keep the update size as minimal as possible.
394394

website/docs/api/reactant-di/classes/optional.Optional.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ custom_edit_url: null
2323

2424
#### Defined in
2525

26-
[packages/reactant-di/src/optional.ts:9](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-di/src/optional.ts#L9)
26+
[packages/reactant-di/src/optional.ts:9](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-di/src/optional.ts#L9)
2727

2828
## Properties
2929

@@ -33,7 +33,7 @@ custom_edit_url: null
3333

3434
#### Defined in
3535

36-
[packages/reactant-di/src/optional.ts:9](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-di/src/optional.ts#L9)
36+
[packages/reactant-di/src/optional.ts:9](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-di/src/optional.ts#L9)
3737

3838
## Accessors
3939

@@ -47,4 +47,4 @@ custom_edit_url: null
4747

4848
#### Defined in
4949

50-
[packages/reactant-di/src/optional.ts:11](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-di/src/optional.ts#L11)
50+
[packages/reactant-di/src/optional.ts:11](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-di/src/optional.ts#L11)

website/docs/api/reactant-di/modules/decorators_inject.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -77,4 +77,4 @@ expect(fooBar.instance.foo.getValue()).toBe('foo');
7777

7878
#### Defined in
7979

80-
[packages/reactant-di/src/decorators/inject.ts:51](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-di/src/decorators/inject.ts#L51)
80+
[packages/reactant-di/src/decorators/inject.ts:51](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-di/src/decorators/inject.ts#L51)

website/docs/api/reactant-di/modules/decorators_injectable.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -109,4 +109,4 @@ expect(fooBar.instance.foo.getValue()).toBe('foo');
109109

110110
#### Defined in
111111

112-
[packages/reactant-di/src/decorators/injectable.ts:84](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-di/src/decorators/injectable.ts#L84)
112+
[packages/reactant-di/src/decorators/injectable.ts:84](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-di/src/decorators/injectable.ts#L84)

website/docs/api/reactant-di/modules/decorators_lazy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -86,4 +86,4 @@ expect(bar.foo?.test).toBe('test');
8686

8787
#### Defined in
8888

89-
[packages/reactant-di/src/decorators/lazy.ts:41](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-di/src/decorators/lazy.ts#L41)
89+
[packages/reactant-di/src/decorators/lazy.ts:41](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-di/src/decorators/lazy.ts#L41)

website/docs/api/reactant-di/modules/decorators_multiInject.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,4 @@ custom_edit_url: null
3838

3939
#### Defined in
4040

41-
[packages/reactant-di/src/decorators/multiInject.ts:6](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-di/src/decorators/multiInject.ts#L6)
41+
[packages/reactant-di/src/decorators/multiInject.ts:6](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-di/src/decorators/multiInject.ts#L6)

website/docs/api/reactant-di/modules/decorators_multiOptional.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,4 @@ custom_edit_url: null
3838

3939
#### Defined in
4040

41-
[packages/reactant-di/src/decorators/multiOptional.ts:7](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-di/src/decorators/multiOptional.ts#L7)
41+
[packages/reactant-di/src/decorators/multiOptional.ts:7](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-di/src/decorators/multiOptional.ts#L7)

website/docs/api/reactant-di/modules/decorators_optional.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -77,4 +77,4 @@ expect(fooBar.fooBar.bar).toBeUndefined();
7777

7878
#### Defined in
7979

80-
[packages/reactant-di/src/decorators/optional.ts:47](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-di/src/decorators/optional.ts#L47)
80+
[packages/reactant-di/src/decorators/optional.ts:47](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-di/src/decorators/optional.ts#L47)

website/docs/api/reactant-di/modules/forwardRef.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ custom_edit_url: null
2424

2525
#### Defined in
2626

27-
[packages/reactant-di/src/forwardRef.ts:4](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-di/src/forwardRef.ts#L4)
27+
[packages/reactant-di/src/forwardRef.ts:4](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-di/src/forwardRef.ts#L4)

website/docs/api/reactant-di/modules/optional.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ custom_edit_url: null
1818

1919
#### Defined in
2020

21-
[packages/reactant-di/src/optional.ts:3](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-di/src/optional.ts#L3)
21+
[packages/reactant-di/src/optional.ts:3](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-di/src/optional.ts#L3)

website/docs/api/reactant-module/classes/core_plugin.PluginModule.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Service.\_\_@storeKey@102401
2929

3030
#### Defined in
3131

32-
[packages/reactant-module/src/core/plugin.ts:15](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/plugin.ts#L15)
32+
[packages/reactant-module/src/core/plugin.ts:15](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-module/src/core/plugin.ts#L15)
3333

3434
___
3535

@@ -41,7 +41,7 @@ inject enhancer for Redux
4141

4242
#### Defined in
4343

44-
[packages/reactant-module/src/core/plugin.ts:32](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/plugin.ts#L32)
44+
[packages/reactant-module/src/core/plugin.ts:32](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-module/src/core/plugin.ts#L32)
4545

4646
___
4747

@@ -53,7 +53,7 @@ inject middleware for Redux
5353

5454
#### Defined in
5555

56-
[packages/reactant-module/src/core/plugin.ts:27](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/plugin.ts#L27)
56+
[packages/reactant-module/src/core/plugin.ts:27](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-module/src/core/plugin.ts#L27)
5757

5858
___
5959

@@ -65,7 +65,7 @@ Define a React Provider for the current PluginModule
6565

6666
#### Defined in
6767

68-
[packages/reactant-module/src/core/plugin.ts:52](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/plugin.ts#L52)
68+
[packages/reactant-module/src/core/plugin.ts:52](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-module/src/core/plugin.ts#L52)
6969

7070
## Methods
7171

@@ -87,7 +87,7 @@ As hook after combine rootReducers
8787

8888
#### Defined in
8989

90-
[packages/reactant-module/src/core/plugin.ts:47](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/plugin.ts#L47)
90+
[packages/reactant-module/src/core/plugin.ts:47](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-module/src/core/plugin.ts#L47)
9191

9292
___
9393

@@ -109,7 +109,7 @@ As hook after createStore
109109

110110
#### Defined in
111111

112-
[packages/reactant-module/src/core/plugin.ts:37](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/plugin.ts#L37)
112+
[packages/reactant-module/src/core/plugin.ts:37](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-module/src/core/plugin.ts#L37)
113113

114114
___
115115

@@ -131,7 +131,7 @@ As hook before combine rootReducers
131131

132132
#### Defined in
133133

134-
[packages/reactant-module/src/core/plugin.ts:42](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/plugin.ts#L42)
134+
[packages/reactant-module/src/core/plugin.ts:42](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-module/src/core/plugin.ts#L42)
135135

136136
___
137137

@@ -153,4 +153,4 @@ preloaded state handler for Redux
153153

154154
#### Defined in
155155

156-
[packages/reactant-module/src/core/plugin.ts:20](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/plugin.ts#L20)
156+
[packages/reactant-module/src/core/plugin.ts:20](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-module/src/core/plugin.ts#L20)

website/docs/api/reactant-module/classes/core_view.ViewModule.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ custom_edit_url: null
1919

2020
#### Defined in
2121

22-
[packages/reactant-module/src/core/view.ts:12](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/view.ts#L12)
22+
[packages/reactant-module/src/core/view.ts:12](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-module/src/core/view.ts#L12)
2323

2424
## Properties
2525

@@ -33,7 +33,7 @@ Service.\_\_@identifierKey@102414
3333

3434
#### Defined in
3535

36-
[packages/reactant-module/src/core/view.ts:8](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/view.ts#L8)
36+
[packages/reactant-module/src/core/view.ts:8](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-module/src/core/view.ts#L8)
3737

3838
___
3939

@@ -47,7 +47,7 @@ Service.\_\_@storeKey@102401
4747

4848
#### Defined in
4949

50-
[packages/reactant-module/src/core/view.ts:10](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/view.ts#L10)
50+
[packages/reactant-module/src/core/view.ts:10](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-module/src/core/view.ts#L10)
5151

5252
## Methods
5353

@@ -69,4 +69,4 @@ React function component defined by the current ViewModule
6969

7070
#### Defined in
7171

72-
[packages/reactant-module/src/core/view.ts:28](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/view.ts#L28)
72+
[packages/reactant-module/src/core/view.ts:28](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-module/src/core/view.ts#L28)

website/docs/api/reactant-module/modules/core_applyMiddleware.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,4 @@ typeof `__class`
4242

4343
#### Defined in
4444

45-
[packages/reactant-module/src/core/applyMiddleware.ts:30](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/applyMiddleware.ts#L30)
45+
[packages/reactant-module/src/core/applyMiddleware.ts:30](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-module/src/core/applyMiddleware.ts#L30)

website/docs/api/reactant-module/modules/core_createState.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,4 +72,4 @@ expect(app.instance.count).toBe(1);
7272

7373
#### Defined in
7474

75-
[packages/reactant-module/src/core/createState.ts:45](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/createState.ts#L45)
75+
[packages/reactant-module/src/core/createState.ts:45](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-module/src/core/createState.ts#L45)

website/docs/api/reactant-module/modules/core_dispatch.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,4 +72,4 @@ expect(app.instance.count).toBe(1);
7272

7373
#### Defined in
7474

75-
[packages/reactant-module/src/core/dispatch.ts:47](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/dispatch.ts#L47)
75+
[packages/reactant-module/src/core/dispatch.ts:47](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-module/src/core/dispatch.ts#L47)

website/docs/api/reactant-module/modules/core_load.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ custom_edit_url: null
2525

2626
#### Defined in
2727

28-
[packages/reactant-module/src/interfaces.ts:219](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/interfaces.ts#L219)
28+
[packages/reactant-module/src/interfaces.ts:219](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-module/src/interfaces.ts#L219)

website/docs/api/reactant-module/modules/core_subscribe.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,4 +64,4 @@ const app = testBed({
6464

6565
#### Defined in
6666

67-
[packages/reactant-module/src/interfaces.ts:142](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/interfaces.ts#L142)
67+
[packages/reactant-module/src/interfaces.ts:142](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-module/src/interfaces.ts#L142)

website/docs/api/reactant-module/modules/core_watch.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,4 +67,4 @@ const app = testBed({
6767

6868
#### Defined in
6969

70-
[packages/reactant-module/src/interfaces.ts:179](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/interfaces.ts#L179)
70+
[packages/reactant-module/src/interfaces.ts:179](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-module/src/interfaces.ts#L179)

website/docs/api/reactant-module/modules/decorators_action.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ expect(app.instance.count).toBe(1);
6262

6363
#### Defined in
6464

65-
[packages/reactant-module/src/decorators/action.ts:47](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/decorators/action.ts#L47)
65+
[packages/reactant-module/src/decorators/action.ts:47](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-module/src/decorators/action.ts#L47)
6666

6767
___
6868

@@ -76,4 +76,4 @@ ___
7676

7777
#### Defined in
7878

79-
[packages/reactant-module/src/decorators/action.ts:17](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/decorators/action.ts#L17)
79+
[packages/reactant-module/src/decorators/action.ts:17](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-module/src/decorators/action.ts#L17)

website/docs/api/reactant-module/modules/decorators_autobind.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -71,4 +71,4 @@ expect(app.instance.list).toEqual(['apple']);
7171

7272
#### Defined in
7373

74-
[packages/reactant-module/src/decorators/autobind.ts:42](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/decorators/autobind.ts#L42)
74+
[packages/reactant-module/src/decorators/autobind.ts:42](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-module/src/decorators/autobind.ts#L42)

website/docs/api/reactant-module/modules/decorators_computed.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,4 +69,4 @@ class Shop {
6969

7070
#### Defined in
7171

72-
[packages/reactant-module/src/decorators/computed.ts:28](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/decorators/computed.ts#L28)
72+
[packages/reactant-module/src/decorators/computed.ts:28](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-module/src/decorators/computed.ts#L28)

website/docs/api/reactant-module/modules/decorators_injectable.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -110,4 +110,4 @@ expect(fooBar.instance.foo.getValue()).toBe('foo');
110110

111111
#### Defined in
112112

113-
[packages/reactant-module/src/decorators/injectable.ts:80](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/decorators/injectable.ts#L80)
113+
[packages/reactant-module/src/decorators/injectable.ts:80](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-module/src/decorators/injectable.ts#L80)

website/docs/api/reactant-module/modules/decorators_lazy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,4 @@ custom_edit_url: null
3939

4040
#### Defined in
4141

42-
[packages/reactant-module/src/decorators/lazy.ts:6](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/decorators/lazy.ts#L6)
42+
[packages/reactant-module/src/decorators/lazy.ts:6](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-module/src/decorators/lazy.ts#L6)

website/docs/api/reactant-module/modules/decorators_state.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,4 @@ expect(app.instance.count).toBe(0);
4747

4848
#### Defined in
4949

50-
[packages/reactant-module/src/decorators/state.ts:26](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/decorators/state.ts#L26)
50+
[packages/reactant-module/src/decorators/state.ts:26](https://github.com/unadlib/reactant/blob/30b550e1/packages/reactant-module/src/decorators/state.ts#L26)

0 commit comments

Comments
 (0)