API Documentation

API Documentation

Home > @acoustic-content-sdk/redux-testing

redux-testing package

Implementation of helper functions and mocks to assist in the implementation of testcases for redux based modules.

Functions

| Function | Description | | --- | --- | | createFetchTextOnFolder(aFolder, aLogSvc) | | | createReduxRootStoreOnFolder(aFolder, aLogSvc) | | | createUrlConfigFromBaseURL(aBaseURL) | Constructs a UrlConfig structure based on a base URL |

Variables

| Variable | Description | | --- | --- | | DEFAULT_URL_CONFIG | Some arbitray default configuration that can be used for testing purposes. | | VERSION | Version and build number of the package |

Home > @acoustic-content-sdk/redux-testing > createFetchTextOnFolder

createFetchTextOnFolder() function

Signature:

export declare function createFetchTextOnFolder(aFolder: string, aLogSvc?: LoggerService): FetchText;

Parameters

| Parameter | Type | Description | | --- | --- | --- | | aFolder | string | | | aLogSvc | LoggerService | |

Returns:

FetchText

Home > @acoustic-content-sdk/redux-testing > createReduxRootStoreOnFolder

createReduxRootStoreOnFolder() function

Signature:

export declare function createReduxRootStoreOnFolder(aFolder: string, aLogSvc?: LoggerService): ReduxRootStore;

Parameters

| Parameter | Type | Description | | --- | --- | --- | | aFolder | string | | | aLogSvc | LoggerService | |

Returns:

ReduxRootStore

Home > @acoustic-content-sdk/redux-testing > createUrlConfigFromBaseURL

createUrlConfigFromBaseURL() function

Constructs a UrlConfig structure based on a base URL

Signature:

export declare function createUrlConfigFromBaseURL(aBaseURL: URL | string): UrlConfig;

Parameters

| Parameter | Type | Description | | --- | --- | --- | | aBaseURL | URL | string | the base URL |

Returns:

UrlConfig

the UrlConfig object

Home > @acoustic-content-sdk/redux-testing > DEFAULT_URL_CONFIG

DEFAULT_URL_CONFIG variable

Some arbitray default configuration that can be used for testing purposes.

Signature:

DEFAULT_URL_CONFIG: UrlConfig

Home > @acoustic-content-sdk/redux-testing > VERSION

VERSION variable

Version and build number of the package

Signature:

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