Skip to content

Commit

Permalink
docs: Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@mnasyrov
mnasyrov committed Aug 3, 2021
1 parent 199cbb7 commit 2b8b5fc
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 28 deletions.
10 changes: 5 additions & 5 deletions packages/rx-effects-react/docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ rx-effects-react

#### Defined in

[useConst.ts:5](https://github.com/mnasyrov/rx-effects/blob/e306eba/packages/rx-effects-react/src/useConst.ts#L5)
[useConst.ts:5](https://github.com/mnasyrov/rx-effects/blob/199cbb7/packages/rx-effects-react/src/useConst.ts#L5)

---

Expand Down Expand Up @@ -64,7 +64,7 @@ rx-effects-react

#### Defined in

[useObservable.ts:4](https://github.com/mnasyrov/rx-effects/blob/e306eba/packages/rx-effects-react/src/useObservable.ts#L4)
[useObservable.ts:4](https://github.com/mnasyrov/rx-effects/blob/199cbb7/packages/rx-effects-react/src/useObservable.ts#L4)

---

Expand All @@ -91,7 +91,7 @@ rx-effects-react

#### Defined in

[useObserver.ts:5](https://github.com/mnasyrov/rx-effects/blob/e306eba/packages/rx-effects-react/src/useObserver.ts#L5)
[useObserver.ts:5](https://github.com/mnasyrov/rx-effects/blob/199cbb7/packages/rx-effects-react/src/useObserver.ts#L5)

---

Expand Down Expand Up @@ -121,7 +121,7 @@ rx-effects-react

#### Defined in

[useSelector.ts:4](https://github.com/mnasyrov/rx-effects/blob/e306eba/packages/rx-effects-react/src/useSelector.ts#L4)
[useSelector.ts:4](https://github.com/mnasyrov/rx-effects/blob/199cbb7/packages/rx-effects-react/src/useSelector.ts#L4)

---

Expand All @@ -147,4 +147,4 @@ rx-effects-react

#### Defined in

[useStateQuery.ts:4](https://github.com/mnasyrov/rx-effects/blob/e306eba/packages/rx-effects-react/src/useStateQuery.ts#L4)
[useStateQuery.ts:4](https://github.com/mnasyrov/rx-effects/blob/199cbb7/packages/rx-effects-react/src/useStateQuery.ts#L4)
46 changes: 23 additions & 23 deletions packages/rx-effects/docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Action is an event emitter

#### Defined in

[action.ts:8](https://github.com/mnasyrov/rx-effects/blob/e306eba/packages/rx-effects/src/action.ts#L8)
[action.ts:8](https://github.com/mnasyrov/rx-effects/blob/199cbb7/packages/rx-effects/src/action.ts#L8)

---

Expand All @@ -76,7 +76,7 @@ type LoggerController = Controller<{

#### Defined in

[controller.ts:14](https://github.com/mnasyrov/rx-effects/blob/e306eba/packages/rx-effects/src/controller.ts#L14)
[controller.ts:14](https://github.com/mnasyrov/rx-effects/blob/199cbb7/packages/rx-effects/src/controller.ts#L14)

---

Expand All @@ -94,7 +94,7 @@ type LoggerController = Controller<{

#### Defined in

[effect.ts:25](https://github.com/mnasyrov/rx-effects/blob/e306eba/packages/rx-effects/src/effect.ts#L25)
[effect.ts:25](https://github.com/mnasyrov/rx-effects/blob/199cbb7/packages/rx-effects/src/effect.ts#L25)

---

Expand Down Expand Up @@ -125,7 +125,7 @@ type LoggerController = Controller<{

#### Defined in

[effect.ts:7](https://github.com/mnasyrov/rx-effects/blob/e306eba/packages/rx-effects/src/effect.ts#L7)
[effect.ts:7](https://github.com/mnasyrov/rx-effects/blob/199cbb7/packages/rx-effects/src/effect.ts#L7)

---

Expand All @@ -135,7 +135,7 @@ type LoggerController = Controller<{

#### Defined in

[effectScope.ts:7](https://github.com/mnasyrov/rx-effects/blob/e306eba/packages/rx-effects/src/effectScope.ts#L7)
[effectScope.ts:7](https://github.com/mnasyrov/rx-effects/blob/199cbb7/packages/rx-effects/src/effectScope.ts#L7)

---

Expand Down Expand Up @@ -164,7 +164,7 @@ type LoggerController = Controller<{

#### Defined in

[effect.ts:16](https://github.com/mnasyrov/rx-effects/blob/e306eba/packages/rx-effects/src/effect.ts#L16)
[effect.ts:16](https://github.com/mnasyrov/rx-effects/blob/199cbb7/packages/rx-effects/src/effect.ts#L16)

---

Expand All @@ -180,7 +180,7 @@ type LoggerController = Controller<{

#### Defined in

[effect.ts:11](https://github.com/mnasyrov/rx-effects/blob/e306eba/packages/rx-effects/src/effect.ts#L11)
[effect.ts:11](https://github.com/mnasyrov/rx-effects/blob/199cbb7/packages/rx-effects/src/effect.ts#L11)

---

Expand All @@ -196,7 +196,7 @@ type LoggerController = Controller<{

#### Defined in

[stateDeclaration.ts:7](https://github.com/mnasyrov/rx-effects/blob/e306eba/packages/rx-effects/src/stateDeclaration.ts#L7)
[stateDeclaration.ts:7](https://github.com/mnasyrov/rx-effects/blob/199cbb7/packages/rx-effects/src/stateDeclaration.ts#L7)

---

Expand Down Expand Up @@ -226,7 +226,7 @@ type LoggerController = Controller<{

#### Defined in

[stateDeclaration.ts:3](https://github.com/mnasyrov/rx-effects/blob/e306eba/packages/rx-effects/src/stateDeclaration.ts#L3)
[stateDeclaration.ts:3](https://github.com/mnasyrov/rx-effects/blob/199cbb7/packages/rx-effects/src/stateDeclaration.ts#L3)

---

Expand Down Expand Up @@ -256,7 +256,7 @@ type LoggerController = Controller<{

#### Defined in

[stateMutation.ts:1](https://github.com/mnasyrov/rx-effects/blob/e306eba/packages/rx-effects/src/stateMutation.ts#L1)
[stateMutation.ts:1](https://github.com/mnasyrov/rx-effects/blob/199cbb7/packages/rx-effects/src/stateMutation.ts#L1)

---

Expand All @@ -279,7 +279,7 @@ type LoggerController = Controller<{

#### Defined in

[stateQuery.ts:4](https://github.com/mnasyrov/rx-effects/blob/e306eba/packages/rx-effects/src/stateQuery.ts#L4)
[stateQuery.ts:4](https://github.com/mnasyrov/rx-effects/blob/199cbb7/packages/rx-effects/src/stateQuery.ts#L4)

---

Expand All @@ -295,13 +295,13 @@ type LoggerController = Controller<{

#### Defined in

[store.ts:6](https://github.com/mnasyrov/rx-effects/blob/e306eba/packages/rx-effects/src/store.ts#L6)
[store.ts:7](https://github.com/mnasyrov/rx-effects/blob/199cbb7/packages/rx-effects/src/store.ts#L7)

---

### Store

Ƭ **Store**<`State`\>: [`StateReader`](README.md#statereader)<`State`\> & { `set`: (`state`: `State`) => `void` ; `update`: (`mutation`: [`StateMutation`](README.md#statemutation)<`State`\>) => `void` }
Ƭ **Store**<`State`\>: [`StateReader`](README.md#statereader)<`State`\> & [`Controller`](README.md#controller)<`Object`\>

#### Type parameters

Expand All @@ -311,7 +311,7 @@ type LoggerController = Controller<{

#### Defined in

[store.ts:18](https://github.com/mnasyrov/rx-effects/blob/e306eba/packages/rx-effects/src/store.ts#L18)
[store.ts:19](https://github.com/mnasyrov/rx-effects/blob/199cbb7/packages/rx-effects/src/store.ts#L19)

## Functions

Expand All @@ -331,7 +331,7 @@ type LoggerController = Controller<{

#### Defined in

[action.ts:15](https://github.com/mnasyrov/rx-effects/blob/e306eba/packages/rx-effects/src/action.ts#L15)
[action.ts:15](https://github.com/mnasyrov/rx-effects/blob/199cbb7/packages/rx-effects/src/action.ts#L15)

---

Expand Down Expand Up @@ -359,7 +359,7 @@ type LoggerController = Controller<{

#### Defined in

[effect.ts:38](https://github.com/mnasyrov/rx-effects/blob/e306eba/packages/rx-effects/src/effect.ts#L38)
[effect.ts:38](https://github.com/mnasyrov/rx-effects/blob/199cbb7/packages/rx-effects/src/effect.ts#L38)

---

Expand All @@ -373,7 +373,7 @@ type LoggerController = Controller<{

#### Defined in

[effectScope.ts:25](https://github.com/mnasyrov/rx-effects/blob/e306eba/packages/rx-effects/src/effectScope.ts#L25)
[effectScope.ts:25](https://github.com/mnasyrov/rx-effects/blob/199cbb7/packages/rx-effects/src/effectScope.ts#L25)

---

Expand All @@ -400,7 +400,7 @@ type LoggerController = Controller<{

#### Defined in

[store.ts:23](https://github.com/mnasyrov/rx-effects/blob/e306eba/packages/rx-effects/src/store.ts#L23)
[store.ts:25](https://github.com/mnasyrov/rx-effects/blob/199cbb7/packages/rx-effects/src/store.ts#L25)

---

Expand All @@ -427,7 +427,7 @@ type LoggerController = Controller<{

#### Defined in

[stateDeclaration.ts:13](https://github.com/mnasyrov/rx-effects/blob/e306eba/packages/rx-effects/src/stateDeclaration.ts#L13)
[stateDeclaration.ts:13](https://github.com/mnasyrov/rx-effects/blob/199cbb7/packages/rx-effects/src/stateDeclaration.ts#L13)

---

Expand Down Expand Up @@ -457,7 +457,7 @@ type LoggerController = Controller<{

#### Defined in

[handleAction.ts:5](https://github.com/mnasyrov/rx-effects/blob/e306eba/packages/rx-effects/src/handleAction.ts#L5)
[handleAction.ts:5](https://github.com/mnasyrov/rx-effects/blob/199cbb7/packages/rx-effects/src/handleAction.ts#L5)

---

Expand Down Expand Up @@ -485,7 +485,7 @@ type LoggerController = Controller<{

#### Defined in

[stateQuery.ts:9](https://github.com/mnasyrov/rx-effects/blob/e306eba/packages/rx-effects/src/stateQuery.ts#L9)
[stateQuery.ts:9](https://github.com/mnasyrov/rx-effects/blob/199cbb7/packages/rx-effects/src/stateQuery.ts#L9)

---

Expand Down Expand Up @@ -514,7 +514,7 @@ type LoggerController = Controller<{

#### Defined in

[stateQuery.ts:19](https://github.com/mnasyrov/rx-effects/blob/e306eba/packages/rx-effects/src/stateQuery.ts#L19)
[stateQuery.ts:19](https://github.com/mnasyrov/rx-effects/blob/199cbb7/packages/rx-effects/src/stateQuery.ts#L19)

---

Expand All @@ -540,4 +540,4 @@ type LoggerController = Controller<{

#### Defined in

[stateMutation.ts:3](https://github.com/mnasyrov/rx-effects/blob/e306eba/packages/rx-effects/src/stateMutation.ts#L3)
[stateMutation.ts:3](https://github.com/mnasyrov/rx-effects/blob/199cbb7/packages/rx-effects/src/stateMutation.ts#L3)

0 comments on commit 2b8b5fc

Please sign in to comment.