Skip to content

parpeoficial/stackerjs-utils

Repository files navigation

Travis Codecov Maintainability Dependencies npm

NPM

StackerJS

Utils

Package of utilities that works nicely in and outside StackerJS

Config

import { Config } from 'stackerjs-utils';

Config.set('any.value', { name: 'stackerjs-utils' });
Config.set('any.type', 'Hello');

Config.get('any.value'); // { "name": "stackerjs" }
Config.get('any.type'); // Hello

.ENV file

When a .env is configured in project root like this:

DB_DRIVER=mysql
APP_NAME=stackerjs-utils

It can be accessed by Config as:

import { Config } from 'stackerjs-utils';

Config.env('db.driver'); // mysql
Config.env('DB_DRIVER'); // mysql

Factory

Permits access easily functions and classes.

Defining

// config/providers.js

module.exports = {
    factories: {
        "FactoryName": function FactoryName()
        {
            //Do something
        },
        "OtherFactory": {
            factory: function Factorial() { /* Do something */ },
            params: { 
                define: "default",
                params: "to",
                be: "accessed",
                by: "factory"
            }
        }
    }
}

Accessing

import { Factory } from "stackerjs-utils";

let otherFactory = Factory("OtherFactory");
otherFactory.define; // default
otherFactory.params; // to

let otherFactory = Factory.make("OtherFactory", { define: "any" });
otherFactory.define; // any
otherFactory.params; // to