API Documentation

Home > @acoustic-content-sdk/redux-feature-handlebars

redux-feature-handlebars package

Functions

| Function | Description | | --- | --- | | isValidHandlebarsTemplateState(aState) | Checks if a template state is valid |

Interfaces

| Interface | Description | | --- | --- | | HandlebarsAddTemplatePayload | | | HandlebarsFeatureState | | | HandlebarsSetErrorPayload | | | HandlebarsSetTemplatePayload | | | HandlebarsTemplateState | |

Variables

| Variable | Description | | --- | --- | | ACTION_HANDLEBARS_ADD_TEMPLATE | | | ACTION_HANDLEBARS_GUARANTEE_TEMPLATE | | | ACTION_HANDLEBARS_LOAD_TEMPLATE | | | ACTION_HANDLEBARS_SET_ERROR | | | ACTION_HANDLEBARS_SET_TEMPLATE | Do not add a side effect to this action | | HANDLEBARS_FEATURE | | | handlebarsAddTemplateAction | | | handlebarsFeature | Exposes the feature module selector | | handlebarsFeatureReducer | | | handlebarsGuaranteeTemplateAction | | | handlebarsLoadTemplateAction | | | handlebarsSetErrorAction | | | handlebarsSetTemplateAction | | | selectHandlebarsFeature | Select the handlebars feature | | selectTemplate | Selects the pre-compiled handlebars template based on the key or returns undefined. | | VERSION | Version and build number of the package |

Type Aliases

| Type Alias | Description | | --- | --- | | HandlebarsActions | | | HandlebarsActionsPayload | | | HandlebarsAddTemplateAction | | | HandlebarsCompiler | | | HandlebarsGuaranteeTemplateAction | | | HandlebarsKey | | | HandlebarsLoadTemplateAction | | | HandlebarsProcessor | | | HandlebarsSetErrorAction | | | HandlebarsSetTemplateAction | | | HandlebarsState | |

Home > @acoustic-content-sdk/redux-feature-handlebars > isValidHandlebarsTemplateState

isValidHandlebarsTemplateState() function

Checks if a template state is valid

Signature:

export declare function isValidHandlebarsTemplateState(aState: HandlebarsTemplateState): boolean;

Parameters

| Parameter | Type | Description | | --- | --- | --- | | aState | HandlebarsTemplateState | the template state |

Returns:

boolean

true if the state is valid, else false

Home > @acoustic-content-sdk/redux-feature-handlebars > HandlebarsAddTemplatePayload

HandlebarsAddTemplatePayload interface

Signature:

export interface HandlebarsAddTemplatePayload 

Properties

| Property | Type | Description | | --- | --- | --- | | key | HandlebarsKey | | | stringTemplate | string | |

Home > @acoustic-content-sdk/redux-feature-handlebars > HandlebarsFeatureState

HandlebarsFeatureState interface

Signature:

export interface HandlebarsFeatureState 

Properties

| Property | Type | Description | | --- | --- | --- | | handlebars | HandlebarsState | |

Home > @acoustic-content-sdk/redux-feature-handlebars > HandlebarsSetErrorPayload

HandlebarsSetErrorPayload interface

Signature:

export interface HandlebarsSetErrorPayload 

Properties

| Property | Type | Description | | --- | --- | --- | | error | Error | | | key | HandlebarsKey | |

Home > @acoustic-content-sdk/redux-feature-handlebars > HandlebarsSetTemplatePayload

HandlebarsSetTemplatePayload interface

Signature:

export interface HandlebarsSetTemplatePayload 

Properties

| Property | Type | Description | | --- | --- | --- | | compiledTemplate | HandlebarsProcessor | | | key | HandlebarsKey | | | stringTemplate | string | |

Home > @acoustic-content-sdk/redux-feature-handlebars > HandlebarsTemplateState

HandlebarsTemplateState interface

Signature:

export interface HandlebarsTemplateState 

Properties

| Property | Type | Description | | --- | --- | --- | | compiledTemplate | HandlebarsProcessor | | | error | Error | | | stringTemplate | string | |

Home > @acoustic-content-sdk/redux-feature-handlebars > ACTION_HANDLEBARS_ADD_TEMPLATE

ACTION_HANDLEBARS_ADD_TEMPLATE variable

Signature:

ACTION_HANDLEBARS_ADD_TEMPLATE = "ACTION_HANDLEBARS_ADD_TEMPLATE"

Home > @acoustic-content-sdk/redux-feature-handlebars > ACTION_HANDLEBARS_GUARANTEE_TEMPLATE

ACTION_HANDLEBARS_GUARANTEE_TEMPLATE variable

Signature:

ACTION_HANDLEBARS_GUARANTEE_TEMPLATE = "ACTION_HANDLEBARS_GUARANTEE_TEMPLATE"

Home > @acoustic-content-sdk/redux-feature-handlebars > ACTION_HANDLEBARS_LOAD_TEMPLATE

ACTION_HANDLEBARS_LOAD_TEMPLATE variable

Signature:

ACTION_HANDLEBARS_LOAD_TEMPLATE = "ACTION_HANDLEBARS_LOAD_TEMPLATE"

Home > @acoustic-content-sdk/redux-feature-handlebars > ACTION_HANDLEBARS_SET_ERROR

ACTION_HANDLEBARS_SET_ERROR variable

Signature:

ACTION_HANDLEBARS_SET_ERROR = "ACTION_HANDLEBARS_SET_ERROR"

Home > @acoustic-content-sdk/redux-feature-handlebars > ACTION_HANDLEBARS_SET_TEMPLATE

ACTION_HANDLEBARS_SET_TEMPLATE variable

Do not add a side effect to this action

Signature:

ACTION_HANDLEBARS_SET_TEMPLATE = "ACTION_HANDLEBARS_SET_TEMPLATE"

Home > @acoustic-content-sdk/redux-feature-handlebars > HANDLEBARS_FEATURE

HANDLEBARS_FEATURE variable

Signature:

HANDLEBARS_FEATURE = "handlebars"

Home > @acoustic-content-sdk/redux-feature-handlebars > handlebarsAddTemplateAction

handlebarsAddTemplateAction variable

Signature:

handlebarsAddTemplateAction: UnaryFunction<HandlebarsAddTemplatePayload, HandlebarsAddTemplateAction>

Home > @acoustic-content-sdk/redux-feature-handlebars > handlebarsFeature

handlebarsFeature variable

Exposes the feature module selector

Signature:

handlebarsFeature: import("@acoustic-content-sdk/redux-store").ReduxFeatureModule<Record<string, import("./handlebars.state").HandlebarsTemplateState>, HandlebarsFeatureState, import("redux").AnyAction, import("redux").AnyAction, any>

Home > @acoustic-content-sdk/redux-feature-handlebars > handlebarsFeatureReducer

handlebarsFeatureReducer variable

Signature:

handlebarsFeatureReducer: {
    handlebars: import("redux").Reducer<Record<string, import("./handlebars.state").HandlebarsTemplateState>, import("./handlebars.actions").HandlebarsSetErrorAction | import("./handlebars.actions").HandlebarsSetTemplateAction>;
}

Home > @acoustic-content-sdk/redux-feature-handlebars > handlebarsGuaranteeTemplateAction

handlebarsGuaranteeTemplateAction variable

Signature:

handlebarsGuaranteeTemplateAction: UnaryFunction<HandlebarsKey, HandlebarsGuaranteeTemplateAction>

Home > @acoustic-content-sdk/redux-feature-handlebars > handlebarsLoadTemplateAction

handlebarsLoadTemplateAction variable

Signature:

handlebarsLoadTemplateAction: UnaryFunction<HandlebarsKey, HandlebarsLoadTemplateAction>

Home > @acoustic-content-sdk/redux-feature-handlebars > handlebarsSetErrorAction

handlebarsSetErrorAction variable

Signature:

handlebarsSetErrorAction: UnaryFunction<HandlebarsSetErrorPayload, HandlebarsSetErrorAction>

Home > @acoustic-content-sdk/redux-feature-handlebars > handlebarsSetTemplateAction

handlebarsSetTemplateAction variable

Signature:

handlebarsSetTemplateAction: UnaryFunction<HandlebarsSetTemplatePayload, HandlebarsSetTemplateAction>

Home > @acoustic-content-sdk/redux-feature-handlebars > selectHandlebarsFeature

selectHandlebarsFeature variable

Select the handlebars feature

Signature:

selectHandlebarsFeature: import("rxjs").UnaryFunction<Record<string, any>, Record<string, import("./handlebars.state").HandlebarsTemplateState>>

Home > @acoustic-content-sdk/redux-feature-handlebars > selectTemplate

selectTemplate variable

Selects the pre-compiled handlebars template based on the key or returns undefined.

Signature:

selectTemplate: (aKey: string) => (aState: Record<string, HandlebarsTemplateState>) => HandlebarsProcessor

Home > @acoustic-content-sdk/redux-feature-handlebars > VERSION

VERSION variable

Version and build number of the package

Signature:

VERSION: {
    version: {
        major: string;
        minor: string;
        patch: string;
        branch: string;
    };
    build: Date;
}

Home > @acoustic-content-sdk/redux-feature-handlebars > HandlebarsActions

HandlebarsActions type

Signature:

export declare type HandlebarsActions = HandlebarsSetTemplateAction | HandlebarsSetErrorAction;

Home > @acoustic-content-sdk/redux-feature-handlebars > HandlebarsActionsPayload

HandlebarsActionsPayload type

Signature:

export declare type HandlebarsActionsPayload = HandlebarsSetTemplatePayload | HandlebarsSetErrorPayload;

Home > @acoustic-content-sdk/redux-feature-handlebars > HandlebarsCompiler

HandlebarsCompiler type

Signature:

export declare type HandlebarsCompiler = (input: string) => HandlebarsProcessor;

Home > @acoustic-content-sdk/redux-feature-handlebars > HandlebarsKey

HandlebarsKey type

Signature:

export declare type HandlebarsKey = string;

Home > @acoustic-content-sdk/redux-feature-handlebars > HandlebarsProcessor

HandlebarsProcessor type

Signature:

export declare type HandlebarsProcessor = (aContext: any) => string;

Home > @acoustic-content-sdk/redux-feature-handlebars > HandlebarsState

HandlebarsState type

Signature:

export declare type HandlebarsState = Record<HandlebarsKey, HandlebarsTemplateState>;

Home > @acoustic-content-sdk/redux-feature-handlebars > HandlebarsAddTemplatePayload > key

HandlebarsAddTemplatePayload.key property

Signature:

key: HandlebarsKey;

Home > @acoustic-content-sdk/redux-feature-handlebars > HandlebarsAddTemplatePayload > stringTemplate

HandlebarsAddTemplatePayload.stringTemplate property

Signature:

stringTemplate: string;

Home > @acoustic-content-sdk/redux-feature-handlebars > HandlebarsTemplateState > compiledTemplate

HandlebarsTemplateState.compiledTemplate property

Signature:

compiledTemplate?: HandlebarsProcessor;

Home > @acoustic-content-sdk/redux-feature-handlebars > HandlebarsTemplateState > error

HandlebarsTemplateState.error property

Signature:

error?: Error;

Home > @acoustic-content-sdk/redux-feature-handlebars > HandlebarsTemplateState > stringTemplate

HandlebarsTemplateState.stringTemplate property

Signature:

stringTemplate?: string;

Home > @acoustic-content-sdk/redux-feature-handlebars > HandlebarsFeatureState > handlebars

HandlebarsFeatureState.handlebars property

Signature:

[HANDLEBARS_FEATURE]: HandlebarsState;

Home > @acoustic-content-sdk/redux-feature-handlebars > HandlebarsSetErrorPayload > error

HandlebarsSetErrorPayload.error property

Signature:

error: Error;

Home > @acoustic-content-sdk/redux-feature-handlebars > HandlebarsSetErrorPayload > key

HandlebarsSetErrorPayload.key property

Signature:

key: HandlebarsKey;

Home > @acoustic-content-sdk/redux-feature-handlebars > HandlebarsSetTemplatePayload > compiledTemplate

HandlebarsSetTemplatePayload.compiledTemplate property

Signature:

compiledTemplate: HandlebarsProcessor;

Home > @acoustic-content-sdk/redux-feature-handlebars > HandlebarsSetTemplatePayload > key

HandlebarsSetTemplatePayload.key property

Signature:

key: HandlebarsKey;

Home > @acoustic-content-sdk/redux-feature-handlebars > HandlebarsSetTemplatePayload > stringTemplate

HandlebarsSetTemplatePayload.stringTemplate property

Signature:

stringTemplate: string;