Fi Utils

Utilities and helpers for Fi Seed based projects.

Installing

npm install --save fi-utils

const fi = require('fi-utils');

This module exports an Object that exposes various methods:

const fi = require('fi-utils');

fi.init(config));

const mycomp = fi.component('my-component');

mycomp.configure(fi.config('my-comp-cfg'));

// ...

An optional Object with the following parameters:

Param	Type	Required	Default	Description
`debug`	`Function\|Boolean`	No	`Function`	Can be a `Function` to log with or a `Boolean`. If `true` it will use `console.log`.
`basedir`	`String`	No	`path.normalize(path.join(__dirname, '..'))`	Absolute path to the app's base dir.
`serverdir`	`String`	No	`__dirname`	Absolute path to the app's server dir.

Method	Arguments	Description
`init`	`config`	This method wil initialize the module with the provided config.
`serverdir`	None	Returns the configured server dir.
`basedir`	None	Returns the configured base dir.
`include`	`relpath`, `name`	Requires a file relative to the server folder.
`config`	`name`	Wrapper to require a config file relative to the `<serverdir>/configs` folder using `include`.
`component`	`name`	Wrapper to require a component file relative to the `<serverdir>/components` folder using `include`.