Skip to content

Commit

Permalink
docs(api): update api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
unadlib committed Feb 6, 2023
1 parent 4ec9191 commit 6373811
Show file tree
Hide file tree
Showing 44 changed files with 208 additions and 207 deletions.
1 change: 1 addition & 0 deletions TODO.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# TODO
- [x] update API docs
- [x] upgrade react-native v0.70.0
- [x] use Mutative
- [ ] upgrade inversify v6
- [ ] upgrade react-router v6.3.0
- [ ] upgrade react v18
Expand Down
6 changes: 3 additions & 3 deletions website/docs/api/reactant-di/classes/optional.Optional.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ custom_edit_url: null

#### Defined in

[packages/reactant-di/src/optional.ts:9](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-di/src/optional.ts#L9)
[packages/reactant-di/src/optional.ts:9](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-di/src/optional.ts#L9)

## Properties

Expand All @@ -33,7 +33,7 @@ custom_edit_url: null

#### Defined in

[packages/reactant-di/src/optional.ts:9](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-di/src/optional.ts#L9)
[packages/reactant-di/src/optional.ts:9](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-di/src/optional.ts#L9)

## Accessors

Expand All @@ -47,4 +47,4 @@ custom_edit_url: null

#### Defined in

[packages/reactant-di/src/optional.ts:11](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-di/src/optional.ts#L11)
[packages/reactant-di/src/optional.ts:11](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-di/src/optional.ts#L11)
2 changes: 1 addition & 1 deletion website/docs/api/reactant-di/modules/decorators_inject.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,4 +77,4 @@ expect(fooBar.instance.foo.getValue()).toBe('foo');

#### Defined in

[packages/reactant-di/src/decorators/inject.ts:51](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-di/src/decorators/inject.ts#L51)
[packages/reactant-di/src/decorators/inject.ts:51](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-di/src/decorators/inject.ts#L51)
Original file line number Diff line number Diff line change
Expand Up @@ -109,4 +109,4 @@ expect(fooBar.instance.foo.getValue()).toBe('foo');

#### Defined in

[packages/reactant-di/src/decorators/injectable.ts:84](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-di/src/decorators/injectable.ts#L84)
[packages/reactant-di/src/decorators/injectable.ts:84](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-di/src/decorators/injectable.ts#L84)
2 changes: 1 addition & 1 deletion website/docs/api/reactant-di/modules/decorators_lazy.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,4 +86,4 @@ expect(bar.foo?.test).toBe('test');

#### Defined in

[packages/reactant-di/src/decorators/lazy.ts:41](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-di/src/decorators/lazy.ts#L41)
[packages/reactant-di/src/decorators/lazy.ts:41](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-di/src/decorators/lazy.ts#L41)
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ custom_edit_url: null

#### Defined in

[packages/reactant-di/src/decorators/multiInject.ts:6](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-di/src/decorators/multiInject.ts#L6)
[packages/reactant-di/src/decorators/multiInject.ts:6](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-di/src/decorators/multiInject.ts#L6)
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ custom_edit_url: null

#### Defined in

[packages/reactant-di/src/decorators/multiOptional.ts:7](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-di/src/decorators/multiOptional.ts#L7)
[packages/reactant-di/src/decorators/multiOptional.ts:7](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-di/src/decorators/multiOptional.ts#L7)
Original file line number Diff line number Diff line change
Expand Up @@ -77,4 +77,4 @@ expect(fooBar.fooBar.bar).toBeUndefined();

#### Defined in

[packages/reactant-di/src/decorators/optional.ts:47](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-di/src/decorators/optional.ts#L47)
[packages/reactant-di/src/decorators/optional.ts:47](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-di/src/decorators/optional.ts#L47)
2 changes: 1 addition & 1 deletion website/docs/api/reactant-di/modules/forwardRef.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ custom_edit_url: null

#### Defined in

[packages/reactant-di/src/forwardRef.ts:4](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-di/src/forwardRef.ts#L4)
[packages/reactant-di/src/forwardRef.ts:4](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-di/src/forwardRef.ts#L4)
2 changes: 1 addition & 1 deletion website/docs/api/reactant-di/modules/optional.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ custom_edit_url: null

#### Defined in

[packages/reactant-di/src/optional.ts:3](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-di/src/optional.ts#L3)
[packages/reactant-di/src/optional.ts:3](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-di/src/optional.ts#L3)
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ custom_edit_url: null

#### Implementation of

Service.\_\_@storeKey@102369
Service.\_\_@storeKey@102401

#### Defined in

[packages/reactant-module/src/core/plugin.ts:15](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-module/src/core/plugin.ts#L15)
[packages/reactant-module/src/core/plugin.ts:15](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/plugin.ts#L15)

___

Expand All @@ -41,7 +41,7 @@ inject enhancer for Redux

#### Defined in

[packages/reactant-module/src/core/plugin.ts:32](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-module/src/core/plugin.ts#L32)
[packages/reactant-module/src/core/plugin.ts:32](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/plugin.ts#L32)

___

Expand All @@ -53,7 +53,7 @@ inject middleware for Redux

#### Defined in

[packages/reactant-module/src/core/plugin.ts:27](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-module/src/core/plugin.ts#L27)
[packages/reactant-module/src/core/plugin.ts:27](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/plugin.ts#L27)

___

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

#### Defined in

[packages/reactant-module/src/core/plugin.ts:52](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-module/src/core/plugin.ts#L52)
[packages/reactant-module/src/core/plugin.ts:52](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/plugin.ts#L52)

## Methods

Expand All @@ -87,7 +87,7 @@ As hook after combine rootReducers

#### Defined in

[packages/reactant-module/src/core/plugin.ts:47](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-module/src/core/plugin.ts#L47)
[packages/reactant-module/src/core/plugin.ts:47](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/plugin.ts#L47)

___

Expand All @@ -109,7 +109,7 @@ As hook after createStore

#### Defined in

[packages/reactant-module/src/core/plugin.ts:37](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-module/src/core/plugin.ts#L37)
[packages/reactant-module/src/core/plugin.ts:37](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/plugin.ts#L37)

___

Expand All @@ -131,7 +131,7 @@ As hook before combine rootReducers

#### Defined in

[packages/reactant-module/src/core/plugin.ts:42](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-module/src/core/plugin.ts#L42)
[packages/reactant-module/src/core/plugin.ts:42](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/plugin.ts#L42)

___

Expand All @@ -153,4 +153,4 @@ preloaded state handler for Redux

#### Defined in

[packages/reactant-module/src/core/plugin.ts:20](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-module/src/core/plugin.ts#L20)
[packages/reactant-module/src/core/plugin.ts:20](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/plugin.ts#L20)
12 changes: 6 additions & 6 deletions website/docs/api/reactant-module/classes/core_view.ViewModule.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ custom_edit_url: null

#### Defined in

[packages/reactant-module/src/core/view.ts:12](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-module/src/core/view.ts#L12)
[packages/reactant-module/src/core/view.ts:12](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/view.ts#L12)

## Properties

Expand All @@ -29,11 +29,11 @@ custom_edit_url: null

#### Implementation of

Service.\_\_@identifierKey@102380
Service.\_\_@identifierKey@102414

#### Defined in

[packages/reactant-module/src/core/view.ts:8](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-module/src/core/view.ts#L8)
[packages/reactant-module/src/core/view.ts:8](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/view.ts#L8)

___

Expand All @@ -43,11 +43,11 @@ ___

#### Implementation of

Service.\_\_@storeKey@102369
Service.\_\_@storeKey@102401

#### Defined in

[packages/reactant-module/src/core/view.ts:10](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-module/src/core/view.ts#L10)
[packages/reactant-module/src/core/view.ts:10](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/view.ts#L10)

## Methods

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

#### Defined in

[packages/reactant-module/src/core/view.ts:28](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-module/src/core/view.ts#L28)
[packages/reactant-module/src/core/view.ts:28](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/view.ts#L28)
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ typeof `__class`

#### Defined in

[packages/reactant-module/src/core/applyMiddleware.ts:30](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-module/src/core/applyMiddleware.ts#L30)
[packages/reactant-module/src/core/applyMiddleware.ts:30](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/applyMiddleware.ts#L30)
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,4 @@ expect(app.instance.count).toBe(1);

#### Defined in

[packages/reactant-module/src/core/createState.ts:45](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-module/src/core/createState.ts#L45)
[packages/reactant-module/src/core/createState.ts:45](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/createState.ts#L45)
2 changes: 1 addition & 1 deletion website/docs/api/reactant-module/modules/core_dispatch.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,4 @@ expect(app.instance.count).toBe(1);

#### Defined in

[packages/reactant-module/src/core/dispatch.ts:47](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-module/src/core/dispatch.ts#L47)
[packages/reactant-module/src/core/dispatch.ts:47](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/core/dispatch.ts#L47)
2 changes: 1 addition & 1 deletion website/docs/api/reactant-module/modules/core_load.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ custom_edit_url: null

#### Defined in

[packages/reactant-module/src/interfaces.ts:211](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-module/src/interfaces.ts#L211)
[packages/reactant-module/src/interfaces.ts:219](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/interfaces.ts#L219)
2 changes: 1 addition & 1 deletion website/docs/api/reactant-module/modules/core_subscribe.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,4 @@ const app = testBed({

#### Defined in

[packages/reactant-module/src/interfaces.ts:134](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-module/src/interfaces.ts#L134)
[packages/reactant-module/src/interfaces.ts:142](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/interfaces.ts#L142)
2 changes: 1 addition & 1 deletion website/docs/api/reactant-module/modules/core_watch.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,4 @@ const app = testBed({

#### Defined in

[packages/reactant-module/src/interfaces.ts:171](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-module/src/interfaces.ts#L171)
[packages/reactant-module/src/interfaces.ts:179](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/interfaces.ts#L179)
4 changes: 2 additions & 2 deletions website/docs/api/reactant-module/modules/decorators_action.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ expect(app.instance.count).toBe(1);

#### Defined in

[packages/reactant-module/src/decorators/action.ts:45](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-module/src/decorators/action.ts#L45)
[packages/reactant-module/src/decorators/action.ts:47](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/decorators/action.ts#L47)

___

Expand All @@ -76,4 +76,4 @@ ___

#### Defined in

[packages/reactant-module/src/decorators/action.ts:15](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-module/src/decorators/action.ts#L15)
[packages/reactant-module/src/decorators/action.ts:17](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/decorators/action.ts#L17)
Original file line number Diff line number Diff line change
Expand Up @@ -71,4 +71,4 @@ expect(app.instance.list).toEqual(['apple']);

#### Defined in

[packages/reactant-module/src/decorators/autobind.ts:42](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-module/src/decorators/autobind.ts#L42)
[packages/reactant-module/src/decorators/autobind.ts:42](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/decorators/autobind.ts#L42)
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,4 @@ class Shop {

#### Defined in

[packages/reactant-module/src/decorators/computed.ts:28](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-module/src/decorators/computed.ts#L28)
[packages/reactant-module/src/decorators/computed.ts:28](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/decorators/computed.ts#L28)
Original file line number Diff line number Diff line change
Expand Up @@ -110,4 +110,4 @@ expect(fooBar.instance.foo.getValue()).toBe('foo');

#### Defined in

[packages/reactant-module/src/decorators/injectable.ts:80](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-module/src/decorators/injectable.ts#L80)
[packages/reactant-module/src/decorators/injectable.ts:80](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/decorators/injectable.ts#L80)
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ custom_edit_url: null

#### Defined in

[packages/reactant-module/src/decorators/lazy.ts:6](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-module/src/decorators/lazy.ts#L6)
[packages/reactant-module/src/decorators/lazy.ts:6](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/decorators/lazy.ts#L6)
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ expect(app.instance.count).toBe(0);

#### Defined in

[packages/reactant-module/src/decorators/state.ts:26](https://github.com/unadlib/reactant/blob/0168c3f1/packages/reactant-module/src/decorators/state.ts#L26)
[packages/reactant-module/src/decorators/state.ts:26](https://github.com/unadlib/reactant/blob/4ec91913/packages/reactant-module/src/decorators/state.ts#L26)
Loading

0 comments on commit 6373811

Please sign in to comment.