npm package: @ibm-wch-sdk/ngrx
Description: Module that implements @ngrx bindings to the login and logout functionality as offered by the @ibm-wch-sdk/ng modules.
Author: Dr. Carsten Leue
Latest version: 6.0.524

<a name="_6413c217ac070f0cc888ef237e5f77bca091ed14c4a6b017e8102394c2fc842d"></a>
# ibm-wch-sdk-ngrx-edit

Module that implements [@ngrx](https://github.com/ngrx/platform) bindings to the login and logout functionality as offered by the [ibm-wch-sdk-ng-edit](https://www.npmjs.com/package/ibm-wch-sdk-ng-edit) modules.

## Details

Refer to the [documentation](#_4f5f0d570547cc32a6c26a19831659ff187906f3e173dec4cc7caa8b01b03375).

## Changes

[CHANGELOG](#_20bdb6f8aeaf2e57d73cf0f8f7596ac3a05ab33429cf49a686e6738debcd4512)

## Class documentation

Refer to the [documentation](#_28a07594e891c43454fa39c2c573639385bbf768c0897d05c3db61d89570388b).

## Usage

Install the module via

```bash
npm install --save ibm-wch-sdk-ngrx-edit
```

## Prereqs

* [ibm-wch-sdk-ng-edit](https://www.npmjs.com/package/ibm-wch-sdk-ng-edit)
* Angular 5.0 or higher


<a name="_4f5f0d570547cc32a6c26a19831659ff187906f3e173dec4cc7caa8b01b03375"></a>
# Rendering Effects Module

This module provides utility classes to connect the [ibm-wch-sdk-ng](https://www.npmjs.com/package/ibm-wch-sdk-ng) library with the [ngrx](https://github.com/ngrx/platform) set of libraries.

## Usecase

The [@ngrx/store](https://www.npmjs.com/package/@ngrx/store) project offers a consistent and efficient way to manage application state. Each aspect of the state is manipulated using a set of actions and persisted by matching reducer functions.

This package offers the actions and reducers related to the concept of a [RenderingContext](https://www.npmjs.com/package/ibm-wch-sdk-api).

Refer to the [documentation](#_db179e19f5e491d487b6cb4061b6dad7e4bb412add21a7dd9b820024b86e5591) for more details.

## Usage

TBD

<a name="_20bdb6f8aeaf2e57d73cf0f8f7596ac3a05ab33429cf49a686e6738debcd4512"></a>
# Changelog

## Current

### Added

* Initial version
<a name="_28a07594e891c43454fa39c2c573639385bbf768c0897d05c3db61d89570388b"></a>

#  @ibm-wch-sdk/ngrx

## Index

### External modules

* ["components/components.reducer"](#_01c37dd18b433d667d6c16aa74f3760ae783ed7c0802881752a0d738681d8377)
* ["index"](#_d53838c3180bb9a0e5494e993ceb8942c9866e807f2cfe89645b7e36005a0cf8)
* ["module"](#_1e2adf2f10b7c6d3f1400cef07b9d1abad4253d5b94cfa77442f7094d1ed888d)
* ["modules/feature.module"](#_258a1bd9794da5395edcdb906bf43d71219c5c0727cc79c897d368b0a317fc4c)
* ["rendering/index"](#_1911d00fc68853469ece15d0928a81b67a62877181d5a5d84d55ef4408b3a2f5)
* ["rendering/rendering.effects"](#_895e35301f7dfd649e611db5ff98f550a3e67387c4e1b597e7d80df0335b2d1f)
* ["rendering/rendering.reducer"](#_77efd3017f0546bbfd43105ae32dd7bfb3052b7fbc66a679d398053340d9d034)
* ["rendering/rendering.selectors"](#_d3514b7b1f08c8590a19fe91a4857602838e2ba16cf36df34ddac17989105e77)

---


<a name="_01c37dd18b433d667d6c16aa74f3760ae783ed7c0802881752a0d738681d8377"></a>
[@ibm-wch-sdk/ngrx](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["components/components.reducer"](#_01c37dd18b433d667d6c16aa74f3760ae783ed7c0802881752a0d738681d8377)

# External module: "components/components.reducer"

## Index

### Functions

* [componentReducer](#_01c37dd18b433d667d6c16aa74f3760ae783ed7c0802881752a0d738681d8377)
* [componentSelector](#_01c37dd18b433d667d6c16aa74f3760ae783ed7c0802881752a0d738681d8377)

---

## Functions

<a id="componentreducer"></a>

### `<Const>` componentReducer

▸ **componentReducer**<`T`,`V`>(reducers: *`ActionReducerMap`<`T`>*): `ActionReducer`<`ComponentState`<`T`>, `V`>

*Defined in components/components.reducer.ts:13*

Implements a reducer that reduces an action targeting a component into an action for that state

**Type parameters:**

#### T 
#### V :  `ComponentAction`
**Parameters:**

| Name | Type | Description |
| ------ | ------ | ------ |
| reducers | `ActionReducerMap`<`T`> |  the state reducers |

**Returns:** `ActionReducer`<`ComponentState`<`T`>, `V`>
component reducer

___
<a id="componentselector"></a>

### `<Const>` componentSelector

▸ **componentSelector**<`T`>(id: *`string`*): `Selector`<`ComponentState`<`T`>, `T`>

*Defined in components/components.reducer.ts:35*

Returns a selector that accesses the state for the given component

**Type parameters:**

#### T 
**Parameters:**

| Name | Type | Description |
| ------ | ------ | ------ |
| id | `string` |  ID of the component |

**Returns:** `Selector`<`ComponentState`<`T`>, `T`>
the selector

___


<a name="_d53838c3180bb9a0e5494e993ceb8942c9866e807f2cfe89645b7e36005a0cf8"></a>
[@ibm-wch-sdk/ngrx](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["index"](#_d53838c3180bb9a0e5494e993ceb8942c9866e807f2cfe89645b7e36005a0cf8)

# External module: "index"

## Index

---


<a name="_1e2adf2f10b7c6d3f1400cef07b9d1abad4253d5b94cfa77442f7094d1ed888d"></a>
[@ibm-wch-sdk/ngrx](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["module"](#_1e2adf2f10b7c6d3f1400cef07b9d1abad4253d5b94cfa77442f7094d1ed888d)

# External module: "module"

## Index

### Classes

* [WchNgrxModule](#_7b20faa716d6cba9abe73e61fc891fd62dbbef80fcc54622a685eaa1c7aab660)

---


<a name="_258a1bd9794da5395edcdb906bf43d71219c5c0727cc79c897d368b0a317fc4c"></a>
[@ibm-wch-sdk/ngrx](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["modules/feature.module"](#_258a1bd9794da5395edcdb906bf43d71219c5c0727cc79c897d368b0a317fc4c)

# External module: "modules/feature.module"

## Index

### Classes

* [WchNgrxFeatureModule](#_ed990f552ca2444b7ad3cbcdfe391bf214609c5a2b4f62a8de56ce647d12b204)

---


<a name="_1911d00fc68853469ece15d0928a81b67a62877181d5a5d84d55ef4408b3a2f5"></a>
[@ibm-wch-sdk/ngrx](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["rendering/index"](#_1911d00fc68853469ece15d0928a81b67a62877181d5a5d84d55ef4408b3a2f5)

# External module: "rendering/index"

## Index

---


<a name="_895e35301f7dfd649e611db5ff98f550a3e67387c4e1b597e7d80df0335b2d1f"></a>
[@ibm-wch-sdk/ngrx](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["rendering/rendering.effects"](#_895e35301f7dfd649e611db5ff98f550a3e67387c4e1b597e7d80df0335b2d1f)

# External module: "rendering/rendering.effects"

## Index

### Classes

* [RenderingEffects](#_7f453fef184472bd63fc90d4cba2eed31ae419d0c91aa9ba9b345dd060d2a59d)

---


<a name="_77efd3017f0546bbfd43105ae32dd7bfb3052b7fbc66a679d398053340d9d034"></a>
[@ibm-wch-sdk/ngrx](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["rendering/rendering.reducer"](#_77efd3017f0546bbfd43105ae32dd7bfb3052b7fbc66a679d398053340d9d034)

# External module: "rendering/rendering.reducer"

## Index

### Variables

* [INITIAL_STATE](#_77efd3017f0546bbfd43105ae32dd7bfb3052b7fbc66a679d398053340d9d034)

### Functions

* [renderingReducer](#_77efd3017f0546bbfd43105ae32dd7bfb3052b7fbc66a679d398053340d9d034)

---

## Variables

<a id="initial_state"></a>

### `<Const>` INITIAL_STATE

**● INITIAL_STATE**: *`RenderingState`*

*Defined in rendering/rendering.reducer.ts:3*

___

## Functions

<a id="renderingreducer"></a>

###  renderingReducer

▸ **renderingReducer**(state?: *`RenderingState`*, action: *`RenderingActions`*): `RenderingState`

*Defined in rendering/rendering.reducer.ts:5*

**Parameters:**

| Name | Type | Default value |
| ------ | ------ | ------ |
| `Default value` state | `RenderingState` |  INITIAL_STATE |
| action | `RenderingActions` | - |

**Returns:** `RenderingState`

___


<a name="_d3514b7b1f08c8590a19fe91a4857602838e2ba16cf36df34ddac17989105e77"></a>
[@ibm-wch-sdk/ngrx](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["rendering/rendering.selectors"](#_d3514b7b1f08c8590a19fe91a4857602838e2ba16cf36df34ddac17989105e77)

# External module: "rendering/rendering.selectors"

## Index

---


<a name="_db179e19f5e491d487b6cb4061b6dad7e4bb412add21a7dd9b820024b86e5591"></a>
## State

The
<a name="_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0"></a>

#  @ibm-wch-sdk/ngrx

## Index

### External modules

* ["components/components.reducer"](#_01c37dd18b433d667d6c16aa74f3760ae783ed7c0802881752a0d738681d8377)
* ["index"](#_d53838c3180bb9a0e5494e993ceb8942c9866e807f2cfe89645b7e36005a0cf8)
* ["module"](#_1e2adf2f10b7c6d3f1400cef07b9d1abad4253d5b94cfa77442f7094d1ed888d)
* ["modules/feature.module"](#_258a1bd9794da5395edcdb906bf43d71219c5c0727cc79c897d368b0a317fc4c)
* ["rendering/index"](#_1911d00fc68853469ece15d0928a81b67a62877181d5a5d84d55ef4408b3a2f5)
* ["rendering/rendering.effects"](#_895e35301f7dfd649e611db5ff98f550a3e67387c4e1b597e7d80df0335b2d1f)
* ["rendering/rendering.reducer"](#_77efd3017f0546bbfd43105ae32dd7bfb3052b7fbc66a679d398053340d9d034)
* ["rendering/rendering.selectors"](#_d3514b7b1f08c8590a19fe91a4857602838e2ba16cf36df34ddac17989105e77)

---


<a name="_7b20faa716d6cba9abe73e61fc891fd62dbbef80fcc54622a685eaa1c7aab660"></a>
[@ibm-wch-sdk/ngrx](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["module"](#_1e2adf2f10b7c6d3f1400cef07b9d1abad4253d5b94cfa77442f7094d1ed888d) > [WchNgrxModule](#_7b20faa716d6cba9abe73e61fc891fd62dbbef80fcc54622a685eaa1c7aab660)

# Class: WchNgrxModule

## Hierarchy

**WchNgrxModule**

## Index

---


<a name="_ed990f552ca2444b7ad3cbcdfe391bf214609c5a2b4f62a8de56ce647d12b204"></a>
[@ibm-wch-sdk/ngrx](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["modules/feature.module"](#_258a1bd9794da5395edcdb906bf43d71219c5c0727cc79c897d368b0a317fc4c) > [WchNgrxFeatureModule](#_ed990f552ca2444b7ad3cbcdfe391bf214609c5a2b4f62a8de56ce647d12b204)

# Class: WchNgrxFeatureModule

## Hierarchy

**WchNgrxFeatureModule**

## Index

---


<a name="_7f453fef184472bd63fc90d4cba2eed31ae419d0c91aa9ba9b345dd060d2a59d"></a>
[@ibm-wch-sdk/ngrx](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["rendering/rendering.effects"](#_895e35301f7dfd649e611db5ff98f550a3e67387c4e1b597e7d80df0335b2d1f) > [RenderingEffects](#_7f453fef184472bd63fc90d4cba2eed31ae419d0c91aa9ba9b345dd060d2a59d)

# Class: RenderingEffects

## Hierarchy

**RenderingEffects**

## Index

### Constructors

* [constructor](#_7f453fef184472bd63fc90d4cba2eed31ae419d0c91aa9ba9b345dd060d2a59d)

### Properties

* [onRefresh](#_7f453fef184472bd63fc90d4cba2eed31ae419d0c91aa9ba9b345dd060d2a59d)

---

## Constructors

<a id="constructor"></a>

###  constructor

⊕ **new RenderingEffects**(aInjector: *`Injector`*): [RenderingEffects](#_7f453fef184472bd63fc90d4cba2eed31ae419d0c91aa9ba9b345dd060d2a59d)

*Defined in rendering/rendering.effects.ts:11*

**Parameters:**

| Name | Type |
| ------ | ------ |
| aInjector | `Injector` |

**Returns:** [RenderingEffects](#_7f453fef184472bd63fc90d4cba2eed31ae419d0c91aa9ba9b345dd060d2a59d)

___

## Properties

<a id="onrefresh"></a>

###  onRefresh

**● onRefresh**: *`Observable`<`Action`>*

*Defined in rendering/rendering.effects.ts:34*

___