@ibm-wch-sdk/ngrx-api

Module that implements @ngrx bindings to the login and logout functionality as offered by the @ibm-wch-sdk/ng modules.

Stats

StarsIssuesVersionUpdatedCreatedSize
@ibm-wch-sdk/ngrx-api
6.0.5242 years ago3 years agoMinified + gzip package size for @ibm-wch-sdk/ngrx-api in KB

Readme

ibm-wch-sdk-ngrx-api

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

CHANGELOG

Class documentation

Refer to the documentation.

Usage

Install the module via

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

Prereqs

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-api

Index

External modules


@ibm-wch-sdk/ngrx-api > "components/component.actions"

External module: "components/component.actions"

Index

Interfaces


@ibm-wch-sdk/ngrx-api > "components/component.selectors"

External module: "components/component.selectors"

Index

Functions


Functions

createComponentSelector

createComponentSelector<T>(aId: string): Selector<ComponentState<T>, T>

Defined in components/component.selectors.ts:5

Type parameters:

T

Parameters:

Name Type
aId string

Returns: Selector<ComponentState<T>, T>


@ibm-wch-sdk/ngrx-api > "components/index"

External module: "components/index"

Index


@ibm-wch-sdk/ngrx-api > "index"

External module: "index"

Index


@ibm-wch-sdk/ngrx-api > "rendering/index"

External module: "rendering/index"

Index


@ibm-wch-sdk/ngrx-api > "rendering/rendering.actions"

External module: "rendering/rendering.actions"

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions


Type aliases

RenderingActions

Ƭ RenderingActions: CurrentRenderingContextAction

Defined in rendering/rendering.actions.ts:37


RenderingCommands

Ƭ RenderingCommands: RefreshCommand

Defined in rendering/rendering.actions.ts:36


Variables

<Const> RENDERING_NAMESPACE

● RENDERING_NAMESPACE: "ibm-wch-sdk-ngrx" = "ibm-wch-sdk-ngrx"

Defined in rendering/rendering.actions.ts:5


Functions

<Const> createRefreshCommand

createRefreshCommand(): RefreshCommand

Defined in rendering/rendering.actions.ts:34

Returns: RefreshCommand


@ibm-wch-sdk/ngrx-api > "rendering/rendering.selectors"

External module: "rendering/rendering.selectors"

Index

Variables

Functions


Variables

<Const> selectApiOrigin

● selectApiOrigin: Selector<RenderingState, string> = createSelector(selectRenderingContext, rc => rc.context.hub.apiUrl.origin)

Defined in rendering/rendering.selectors.ts:10


<Const> selectDeliveryOrigin

● selectDeliveryOrigin: Selector<RenderingState, string> = createSelector(selectRenderingContext, rc => rc.context.hub.deliveryUrl.origin)

Defined in rendering/rendering.selectors.ts:11


<Const> selectRenderingState

● selectRenderingState: Selector<any, RenderingState> = createFeatureSelector(RENDERING_NAMESPACE)

Defined in rendering/rendering.selectors.ts:7


<Const> selectSitePage

● selectSitePage: Selector<RenderingState, SitePage> = createSelector(selectRenderingContext, pageFromRenderingContext)

Defined in rendering/rendering.selectors.ts:9


Functions

<Const> selectRenderingContext

selectRenderingContext(state: RenderingState): RenderingContext

Defined in rendering/rendering.selectors.ts:8

Parameters:

Name Type
state RenderingState

Returns: RenderingContext


State

The

@ibm-wch-sdk/ngrx-api

Index

External modules


@ibm-wch-sdk/ngrx-api > "components/component.actions" > ComponentAction

Interface: ComponentAction

Hierarchy

Action

↳ ComponentAction

Index

Properties


Properties

id

● id: string

Defined in components/component.actions.ts:11


type

● type: string

Inherited from Action.type

Defined in /usr/build/node_modules/@ngrx/store/src/models.d.ts:2


@ibm-wch-sdk/ngrx-api > "components/component.actions" > ComponentState

Interface: ComponentState

Maps from component ID to component state

Type parameters

T

Hierarchy

ComponentState

Indexable

[id: string]: T Maps from component ID to component state

Index


@ibm-wch-sdk/ngrx-api > "rendering/rendering.actions" > RenderingActionTypes

Enumeration: RenderingActionTypes

Index

Enumeration members


Enumeration members

CURRENT_RENDERING_CONTEXT

CURRENT_RENDERING_CONTEXT: = "ibm-wch-sdk-ngrx:currentRenderingContext"

Defined in rendering/rendering.actions.ts:12


REFRESH_COMMAND

REFRESH_COMMAND: = "ibm-wch-sdk-ngrx:refresh"

Defined in rendering/rendering.actions.ts:13


@ibm-wch-sdk/ngrx-api > "rendering/rendering.actions" > CurrentRenderingContextAction

Class: CurrentRenderingContextAction

Hierarchy

CurrentRenderingContextAction

Implements

Index

Constructors

Properties


Constructors

constructor

new CurrentRenderingContextAction(renderingContext: RenderingContext): CurrentRenderingContextAction

Defined in rendering/rendering.actions.ts:27

Parameters:

Name Type
renderingContext RenderingContext

Returns: CurrentRenderingContextAction


Properties

renderingContext

● renderingContext: RenderingContext

Defined in rendering/rendering.actions.ts:29


type

● type: CURRENT_RENDERING_CONTEXT = RenderingActionTypes.CURRENT_RENDERING_CONTEXT

Implementation of AbstractRenderingAction.type

Defined in rendering/rendering.actions.ts:27


@ibm-wch-sdk/ngrx-api > "rendering/rendering.actions" > RefreshCommand

Class: RefreshCommand

Hierarchy

RefreshCommand

Implements

Index

Properties


Properties

type

● type: REFRESH_COMMAND = RenderingActionTypes.REFRESH_COMMAND

Implementation of AbstractRenderingAction.type

Defined in rendering/rendering.actions.ts:22


@ibm-wch-sdk/ngrx-api > "rendering/rendering.actions" > AbstractRenderingAction

Interface: AbstractRenderingAction

Hierarchy

Action

↳ AbstractRenderingAction

Implemented by

Index

Properties


Properties

type

● type: RenderingActionTypes

Overrides Action.type

Defined in rendering/rendering.actions.ts:17


@ibm-wch-sdk/ngrx-api > "rendering/rendering.actions" > RenderingState

Interface: RenderingState

Hierarchy

RenderingState

Index

Properties


Properties

<Optional> renderingContext

● renderingContext: RenderingContext

Defined in rendering/rendering.actions.ts:8


If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.