@ibm-wch-sdk/ngrx
v6.0.524
Published
Module that implements @ngrx bindings to the login and logout functionality as offered by the @ibm-wch-sdk/ng modules.
Downloads
2
Keywords
Readme
ibm-wch-sdk-ngrx-edit
Module that implements @ngrx bindings to the login and logout functionality as offered by the ibm-wch-sdk-ng-edit modules.
Details
Refer to the documentation.
Changes
Class documentation
Refer to the documentation.
Usage
Install the module via
npm install --save ibm-wch-sdk-ngrx-edit
Prereqs
- ibm-wch-sdk-ng-edit
- Angular 5.0 or higher
Rendering Effects Module
This module provides utility classes to connect the ibm-wch-sdk-ng library with the ngrx set of libraries.
Usecase
The @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.
Refer to the documentation for more details.
Usage
TBD
Changelog
Current
Added
- Initial version
@ibm-wch-sdk/ngrx
Index
External modules
- "components/components.reducer"
- "index"
- "module"
- "modules/feature.module"
- "rendering/index"
- "rendering/rendering.effects"
- "rendering/rendering.reducer"
- "rendering/rendering.selectors"
@ibm-wch-sdk/ngrx > "components/components.reducer"
External module: "components/components.reducer"
Index
Functions
Functions
<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
<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
External module: "index"
Index
External module: "module"
Index
Classes
@ibm-wch-sdk/ngrx > "modules/feature.module"
External module: "modules/feature.module"
Index
Classes
@ibm-wch-sdk/ngrx > "rendering/index"
External module: "rendering/index"
Index
@ibm-wch-sdk/ngrx > "rendering/rendering.effects"
External module: "rendering/rendering.effects"
Index
Classes
@ibm-wch-sdk/ngrx > "rendering/rendering.reducer"
External module: "rendering/rendering.reducer"
Index
Variables
Functions
Variables
<Const>
INITIAL_STATE
● INITIAL_STATE: RenderingState
Defined in rendering/rendering.reducer.ts:3
Functions
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
@ibm-wch-sdk/ngrx > "rendering/rendering.selectors"
External module: "rendering/rendering.selectors"
Index
State
The
@ibm-wch-sdk/ngrx
Index
External modules
- "components/components.reducer"
- "index"
- "module"
- "modules/feature.module"
- "rendering/index"
- "rendering/rendering.effects"
- "rendering/rendering.reducer"
- "rendering/rendering.selectors"
@ibm-wch-sdk/ngrx > "module" > WchNgrxModule
Class: WchNgrxModule
Hierarchy
WchNgrxModule
Index
@ibm-wch-sdk/ngrx > "modules/feature.module" > WchNgrxFeatureModule
Class: WchNgrxFeatureModule
Hierarchy
WchNgrxFeatureModule
Index
@ibm-wch-sdk/ngrx > "rendering/rendering.effects" > RenderingEffects
Class: RenderingEffects
Hierarchy
RenderingEffects
Index
Constructors
Properties
Constructors
constructor
⊕ new RenderingEffects(aInjector: Injector
): RenderingEffects
Defined in rendering/rendering.effects.ts:11
Parameters:
| Name | Type |
| ------ | ------ |
| aInjector | Injector
|
Returns: RenderingEffects
Properties
onRefresh
● onRefresh: Observable
<Action
>
Defined in rendering/rendering.effects.ts:34