docs: Docs

mnasyrov · Sep 7, 2021 · f40f039 · f40f039
1 parent 5cc97e0
commit f40f039
Show file tree

Hide file tree

Showing 2 changed files with 77 additions and 47 deletions.
diff --git a/packages/rx-effects-react/docs/README.md b/packages/rx-effects-react/docs/README.md
@@ -41,7 +41,7 @@ If the factory is provided, it is called only once.
 
 #### Defined in
 
-[rx-effects-react/src/useConst.ts:12](https://github.com/mnasyrov/rx-effects/blob/156abcc/packages/rx-effects-react/src/useConst.ts#L12)
+[rx-effects-react/src/useConst.ts:12](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects-react/src/useConst.ts#L12)
 
 ---
 
@@ -74,7 +74,7 @@ included explicitly when it is needed.
 
 #### Defined in
 
-[rx-effects-react/src/useController.ts:17](https://github.com/mnasyrov/rx-effects/blob/156abcc/packages/rx-effects-react/src/useController.ts#L17)
+[rx-effects-react/src/useController.ts:17](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects-react/src/useController.ts#L17)
 
 ---
 
@@ -113,7 +113,7 @@ const value = useObservable<string>(source$, undefined);
 
 #### Defined in
 
-[rx-effects-react/src/useObservable.ts:19](https://github.com/mnasyrov/rx-effects/blob/156abcc/packages/rx-effects-react/src/useObservable.ts#L19)
+[rx-effects-react/src/useObservable.ts:19](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects-react/src/useObservable.ts#L19)
 
 ---
 
@@ -153,7 +153,7 @@ useObserver(source$, observer);
 
 #### Defined in
 
-[rx-effects-react/src/useObserver.ts:21](https://github.com/mnasyrov/rx-effects/blob/156abcc/packages/rx-effects-react/src/useObserver.ts#L21)
+[rx-effects-react/src/useObserver.ts:21](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects-react/src/useObserver.ts#L21)
 
 ---
 
@@ -199,7 +199,7 @@ const value = useSelector<{ data: Record<string, string> }>(
 
 #### Defined in
 
-[rx-effects-react/src/useSelector.ts:26](https://github.com/mnasyrov/rx-effects/blob/156abcc/packages/rx-effects-react/src/useSelector.ts#L26)
+[rx-effects-react/src/useSelector.ts:27](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects-react/src/useSelector.ts#L27)
 
 ---
 
@@ -227,4 +227,4 @@ Returns a value which is provided by the query.
 
 #### Defined in
 
-[rx-effects-react/src/useStateQuery.ts:9](https://github.com/mnasyrov/rx-effects/blob/156abcc/packages/rx-effects-react/src/useStateQuery.ts#L9)
+[rx-effects-react/src/useStateQuery.ts:9](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects-react/src/useStateQuery.ts#L9)
diff --git a/packages/rx-effects/docs/README.md b/packages/rx-effects/docs/README.md
@@ -17,6 +17,7 @@ rx-effects
 - [StateFactory](README.md#statefactory)
 - [StateMutation](README.md#statemutation)
 - [StateQuery](README.md#statequery)
+- [StateQueryOptions](README.md#statequeryoptions)
 - [StateReader](README.md#statereader)
 - [Store](README.md#store)
 
@@ -65,7 +66,7 @@ submitForm.even$.subscribe((formData) => {
 
 #### Defined in
 
-[action.ts:22](https://github.com/mnasyrov/rx-effects/blob/156abcc/packages/rx-effects/src/action.ts#L22)
+[action.ts:22](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects/src/action.ts#L22)
 
 ---
 
@@ -94,7 +95,7 @@ type LoggerController = Controller<{
 
 #### Defined in
 
-[controller.ts:17](https://github.com/mnasyrov/rx-effects/blob/156abcc/packages/rx-effects/src/controller.ts#L17)
+[controller.ts:17](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects/src/controller.ts#L17)
 
 ---
 
@@ -120,7 +121,7 @@ unsubscribe from them and deactivate the effect.
 
 #### Defined in
 
-[effect.ts:56](https://github.com/mnasyrov/rx-effects/blob/156abcc/packages/rx-effects/src/effect.ts#L56)
+[effect.ts:56](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects/src/effect.ts#L56)
 
 ---
 
@@ -153,7 +154,7 @@ Handler for an event. It can be asynchronous.
 
 #### Defined in
 
-[effect.ts:12](https://github.com/mnasyrov/rx-effects/blob/156abcc/packages/rx-effects/src/effect.ts#L12)
+[effect.ts:12](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects/src/effect.ts#L12)
 
 ---
 
@@ -184,7 +185,7 @@ Details about performing the effect.
 
 #### Defined in
 
-[effect.ts:27](https://github.com/mnasyrov/rx-effects/blob/156abcc/packages/rx-effects/src/effect.ts#L27)
+[effect.ts:27](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects/src/effect.ts#L27)
 
 ---
 
@@ -202,7 +203,7 @@ Options for handling an action or observable.
 
 #### Defined in
 
-[effect.ts:19](https://github.com/mnasyrov/rx-effects/blob/156abcc/packages/rx-effects/src/effect.ts#L19)
+[effect.ts:19](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects/src/effect.ts#L19)
 
 ---
 
@@ -217,7 +218,7 @@ It collects all subscriptions which are made by child entities and provides
 
 #### Defined in
 
-[scope.ts:15](https://github.com/mnasyrov/rx-effects/blob/156abcc/packages/rx-effects/src/scope.ts#L15)
+[scope.ts:16](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects/src/scope.ts#L16)
 
 ---
 
@@ -235,7 +236,7 @@ Declaration of a state.
 
 #### Defined in
 
-[stateDeclaration.ts:12](https://github.com/mnasyrov/rx-effects/blob/156abcc/packages/rx-effects/src/stateDeclaration.ts#L12)
+[stateDeclaration.ts:12](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects/src/stateDeclaration.ts#L12)
 
 ---
 
@@ -268,7 +269,7 @@ state.
 
 #### Defined in
 
-[stateDeclaration.ts:7](https://github.com/mnasyrov/rx-effects/blob/156abcc/packages/rx-effects/src/stateDeclaration.ts#L7)
+[stateDeclaration.ts:7](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects/src/stateDeclaration.ts#L7)
 
 ---
 
@@ -317,7 +318,7 @@ a next state
 
 #### Defined in
 
-[stateMutation.ts:19](https://github.com/mnasyrov/rx-effects/blob/156abcc/packages/rx-effects/src/stateMutation.ts#L19)
+[stateMutation.ts:19](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects/src/stateMutation.ts#L19)
 
 ---
 
@@ -342,13 +343,38 @@ Provider for a value of a state.
 
 #### Defined in
 
-[stateQuery.ts:7](https://github.com/mnasyrov/rx-effects/blob/156abcc/packages/rx-effects/src/stateQuery.ts#L7)
+[stateQuery.ts:8](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects/src/stateQuery.ts#L8)
+
+---
+
+### StateQueryOptions
+
+Ƭ **StateQueryOptions**<`T`, `K`\>: { `distinct?`: `false` } \| { `comparator?`: (`previous`: `K`, `current`: `K`) => `boolean` ; `distinct`: `true` ; `keySelector?`: (`value`: `T`) => `K` }
+
+Options for processing the query result
+
+**`property`** distinct Enables distinct results
+
+**`property`** comparator Custom comparator for values. Strict equality `===` is used by default.
+
+**`property`** keySelector Getter for keys of values to compare. Values itself are used for comparing by default.
+
+#### Type parameters
+
+| Name |
+| :--- |
+| `T`  |
+| `K`  |
+
+#### Defined in
+
+[stateQuery.ts:23](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects/src/stateQuery.ts#L23)
 
 ---
 
 ### StateReader
 
-Ƭ **StateReader**<`State`\>: [`StateQuery`](README.md#statequery)<`State`\> & { `query`: <R\>(`selector`: (`state`: `State`) => `R`, `compare?`: (`v1`: `R`, `v2`: `R`) => `boolean`) => [`StateQuery`](README.md#statequery)<`R`\> ; `select`: <R\>(`selector`: (`state`: `State`) => `R`, `compare?`: (`v1`: `R`, `v2`: `R`) => `boolean`) => `Observable`<`R`\> }
+Ƭ **StateReader**<`State`\>: [`StateQuery`](README.md#statequery)<`State`\> & { `query`: <R, K\>(`selector`: (`state`: `State`) => `R`, `options?`: [`StateQueryOptions`](README.md#statequeryoptions)<`R`, `K`\>) => [`StateQuery`](README.md#statequery)<`R`\> ; `select`: <R, K\>(`selector`: (`state`: `State`) => `R`, `options?`: [`StateQueryOptions`](README.md#statequeryoptions)<`R`, `K`\>) => `Observable`<`R`\> }
 
 Read-only type of the state store.
 
@@ -360,7 +386,7 @@ Read-only type of the state store.
 
 #### Defined in
 
-[store.ts:10](https://github.com/mnasyrov/rx-effects/blob/156abcc/packages/rx-effects/src/store.ts#L10)
+[store.ts:10](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects/src/store.ts#L10)
 
 ---
 
@@ -376,7 +402,7 @@ Read-only type of the state store.
 
 #### Defined in
 
-[store.ts:40](https://github.com/mnasyrov/rx-effects/blob/156abcc/packages/rx-effects/src/store.ts#L40)
+[store.ts:42](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects/src/store.ts#L42)
 
 ## Functions
 
@@ -396,7 +422,7 @@ Read-only type of the state store.
 
 #### Defined in
 
-[action.ts:29](https://github.com/mnasyrov/rx-effects/blob/156abcc/packages/rx-effects/src/action.ts#L29)
+[action.ts:29](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects/src/action.ts#L29)
 
 ---
 
@@ -434,7 +460,7 @@ const sumEffect = createEffect<{ a: number; b: number }, number>((event) => {
 
 #### Defined in
 
-[effect.ts:83](https://github.com/mnasyrov/rx-effects/blob/156abcc/packages/rx-effects/src/effect.ts#L83)
+[effect.ts:83](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects/src/effect.ts#L83)
 
 ---
 
@@ -450,7 +476,7 @@ Creates `Scope` instance.
 
 #### Defined in
 
-[scope.ts:67](https://github.com/mnasyrov/rx-effects/blob/156abcc/packages/rx-effects/src/scope.ts#L67)
+[scope.ts:68](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects/src/scope.ts#L68)
 
 ---
 
@@ -479,7 +505,7 @@ Creates the state store.
 
 #### Defined in
 
-[store.ts:56](https://github.com/mnasyrov/rx-effects/blob/156abcc/packages/rx-effects/src/store.ts#L56)
+[store.ts:58](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects/src/store.ts#L58)
 
 ---
 
@@ -508,7 +534,7 @@ Declares the state.
 
 #### Defined in
 
-[stateDeclaration.ts:29](https://github.com/mnasyrov/rx-effects/blob/156abcc/packages/rx-effects/src/stateDeclaration.ts#L29)
+[stateDeclaration.ts:29](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects/src/stateDeclaration.ts#L29)
 
 ---
 
@@ -540,69 +566,73 @@ This helper creates `Effect` from `handler` and subscribes it to `source`.
 
 #### Defined in
 
-[handleAction.ts:8](https://github.com/mnasyrov/rx-effects/blob/156abcc/packages/rx-effects/src/handleAction.ts#L8)
+[handleAction.ts:8](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects/src/handleAction.ts#L8)
 
 ---
 
 ### mapQuery
 
-▸ **mapQuery**<`T`, `R`\>(`query`, `mapper`): [`StateQuery`](README.md#statequery)<`R`\>
+▸ **mapQuery**<`T`, `R`, `K`\>(`query`, `mapper`, `options?`): [`StateQuery`](README.md#statequery)<`R`\>
 
 Returns a new `StateQuery` which maps a source value by the provided mapping
 function.
 
 #### Type parameters
 
-| Name |
-| :--- |
-| `T`  |
-| `R`  |
+| Name | Type |
+| :--- | :--- |
+| `T`  | `T`  |
+| `R`  | `R`  |
+| `K`  | `R`  |
 
 #### Parameters
 
-| Name     | Type                                       | Description  |
-| :------- | :----------------------------------------- | :----------- |
-| `query`  | [`StateQuery`](README.md#statequery)<`T`\> | source query |
-| `mapper` | (`value`: `T`) => `R`                      | value mapper |
+| Name       | Type                                                          | Description                             |
+| :--------- | :------------------------------------------------------------ | :-------------------------------------- |
+| `query`    | [`StateQuery`](README.md#statequery)<`T`\>                    | source query                            |
+| `mapper`   | (`value`: `T`) => `R`                                         | value mapper                            |
+| `options?` | [`StateQueryOptions`](README.md#statequeryoptions)<`R`, `K`\> | options for processing the result value |
 
 #### Returns
 
 [`StateQuery`](README.md#statequery)<`R`\>
 
 #### Defined in
 
-[stateQuery.ts:22](https://github.com/mnasyrov/rx-effects/blob/156abcc/packages/rx-effects/src/stateQuery.ts#L22)
+[stateQuery.ts:41](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects/src/stateQuery.ts#L41)
 
 ---
 
 ### mergeQueries
 
-▸ **mergeQueries**<`Values`, `Result`\>(`queries`, `merger`): [`StateQuery`](README.md#statequery)<`Result`\>
+▸ **mergeQueries**<`Values`, `Result`, `ResultKey`\>(`queries`, `merger`, `options?`): [`StateQuery`](README.md#statequery)<`Result`\>
 
 Returns a new `StateQuery` which takes the latest values from source queries
 and merges them into a single value.
 
 #### Type parameters
 
-| Name     | Type                |
-| :------- | :------------------ |
-| `Values` | extends `unknown`[] |
-| `Result` | `Result`            |
+| Name        | Type                |
+| :---------- | :------------------ |
+| `Values`    | extends `unknown`[] |
+| `Result`    | `Result`            |
+| `ResultKey` | `Result`            |
 
 #### Parameters
 
-| Name      | Type                                                | Description    |
-| :-------- | :-------------------------------------------------- | :------------- |
-| `queries` | [...{ [K in keyof Values]: StateQuery<Values[K]\>}] | source queries |
-| `merger`  | (...`values`: `Values`) => `Result`                 | value merger   |
+| Name       | Type                                                                       | Description                             |
+| :--------- | :------------------------------------------------------------------------- | :-------------------------------------- |
+| `queries`  | [...{ [K in keyof Values]: StateQuery<Values[K]\>}]                        | source queries                          |
+| `merger`   | (...`values`: `Values`) => `Result`                                        | value merger                            |
+| `options?` | [`StateQueryOptions`](README.md#statequeryoptions)<`Result`, `ResultKey`\> | options for processing the result value |
 
 #### Returns
 
 [`StateQuery`](README.md#statequery)<`Result`\>
 
 #### Defined in
 
-[stateQuery.ts:39](https://github.com/mnasyrov/rx-effects/blob/156abcc/packages/rx-effects/src/stateQuery.ts#L39)
+[stateQuery.ts:66](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects/src/stateQuery.ts#L66)
 
 ---
 
@@ -632,4 +662,4 @@ You can use this helper to apply multiple changes at the same time.
 
 #### Defined in
 
-[stateMutation.ts:26](https://github.com/mnasyrov/rx-effects/blob/156abcc/packages/rx-effects/src/stateMutation.ts#L26)
+[stateMutation.ts:26](https://github.com/mnasyrov/rx-effects/blob/5cc97e0/packages/rx-effects/src/stateMutation.ts#L26)