WEKA Frontend Helpers
Installation
yarn add --dev @industry/helpers
Configuration helper
Since setting up the configuration helper is a two step process here is a dedicated section for it.
Setting up the helper
// File: lib/config.js
// Import Repository and repositoryHelper
import { Repository, repositoryHelper } from '@industry/helpers';
const data = {
app_name: 'FooApp',
blog: {
title: 'My Blog',
description: "Just bloggin' around"
}
};
// Create a Repository instance using the repositoryHelper
const instance = repositoryHelper( new Repository(data) );
// Export the instance
export default instance;
Usage
// File: index.js
// Import previously created instance
import config from './lib/config.js'
const repository = config();
// -> Returns the Repository instance
const title = config('blog.title');
// -> "My Blog"
const defaultTitle = config('blog.foo', 'This is a default value');
// -> "This is a default value"
config(['blog.url', 'https://example.com/blog']);
const url = config('blog.url');
// -> "https://example.com/blog"
API
Table of Contents
Configuration Repository
Repository
A configuration repository.
Parameters
-
data
Object The repository's data.
get
src/Config/Repository.js:24-30
Returns the value for the given object path. If the value was not found in the object, defaultValue will be returned.
Parameters
-
path
string -
defaultValue
mixed (optional, defaultundefined
)
Returns mixed
getAll
src/Config/Repository.js:36-38
Returns a copy of the whole underlying repository data.
Returns object
set
src/Config/Repository.js:45-51
Saves given value under given path.
Parameters
-
path
stirng -
value
any
helper
A convenient function to access the config repository. If path is an instance of Repository it will be used as the config's repository. If path is not null the value from a previously set config repository's path will be returned. If the value was not found in the current config repository, the given defaultValue will be returned. If path is null, an instance of the config repository will be returned.
Usage: helper( new Config({ foo: 'bar' }) -> To set a shared config repository helper('foo') -> To access 'foo' of a previously set config repository helper('foo2', 'my default value') -> Usage with a default value helper() -> returns
Parameters
-
path
(string | null | Repository) (optional, defaultnull
) -
defaultValue
mixed (optional, defaultundefined
)
Returns mixed
Available Functions
getScriptParams
src/functions/get-script-params.js:9-21
Returns a key/value object of query string parameters of given script element.
Parameters
-
script
HTMLScriptElement -
castValuesToProperTypes
Bool Indicates if values should be casted to appropriate types. (optional, defaulttrue
)
Returns Object
queryStringToObject
src/functions/query-string-to-object.js:35-68
Parses given query string to a key/value object.
Parameters
-
queryString
String -
castValuesToProperTypes
Bool Indicates if values should be casted to appropriate types. (optional, defaulttrue
)
Returns Object
attemptCast
src/functions/query-string-to-object.js:5-27
Attempts to cast given value to its appropriate type.
Parameters
-
value
any