@csgis/bricjs-loader v0.0.2

BricJS loader

BricJS lets you integrate reusable modules in an application easily.

You might want to use it in combination of the json-modules-loader and json-module-args-loader. See an example.

Install

With npm:

npm add --save-dev @csgis/bricjs-loader

With yarn:

yarn add -D @csgis/bricjs-loader

Usage

greeting.js:

export default function (props, timeService, renderer) {
  if (timeService.isAfternoon()) {
    renderer.render('Good afternoon, ' + props.name);
  } else {
    renderer.render('Hello, ' + props.name);
  }
}

main.js:

import load from '@csgis/bricjs-loader';
import greeting from './greeting';
import time from 'someTimeRenderer';
import render from 'someRenderer';

let config = {
  "greeting": {
    "name": "Víctor"
  }
};

let modules = { greeting, time, render };
let deps = {
  greeting: [time, render]
}

load(config, modules, deps);

API

It exports a single default function expecting the following parameters:

• config (Object or Array of Object). Each object is considered a context. For each context, keys are module names (used by the other arguments); values are the props values to be passed to the modules when called (first argument).

• modules (Object): Keys are module names (used by the other arguments); values are functions to be called.

  Those functions must accept the following arguments:

  • props: An object with data for customizing the module.
  • ...deps: One or more dependencies, as separated arguments.

  For example:

  export function bricjs(props, timeService, renderer) {
    if (timeService.isAfternoon()) {
      renderer.render('Good afternoon, ' + props.name);
    } else {
      renderer.render('Hello, ' + props.name);
    }
  }

• deps (Object): Keys are modules names (used by the other arguments); values are arrays of module names to be passed as dependencies for the functions in modules.

IMPORTANT: Each module can be disabled (its bricjs function will never be called) via configuration by adding the enabled property with a false value. For example:

{
  "greeting": {
    "name": "Víctor",
    "enabled": false
  }
}