ESF-Utl


Road map

| Version | Functionality | Status |
| ------- | -------------------------------------------------------------------------------------------------- | -------- |
| 0.1.0 | Logging (req: esf-utl-1.1, esf-utl-1.4, esf-utl-1.5) | released |
| 0.2.0 | Basic path operathins (req. esf-utl-1.3) | released |
| 1.0.0 | Promises error handling esf-utl-1.2 | released |
| 2.0.0 | Implement API v.2.0, reqs esf-utl-1.2 | released |
| 2.1.0 | Implement actual ESF-spec (v.2.5), update to babel v.6 , reqs esf-utl-2.1 | released |
| 2.2.0 | Implement API v.2.2, reqs esf-utl-3.0 | released |
| 3.0.0 | Implement API v.3.0, reqs esf-utl-4.0 | released |
| 3.2.0 | Implement aliases e, l: req esf-utl-5.0 | released |

Requirements

$3

ReqId | Requirement | Implementation Methods
----------- | -------------------------------------------------------------------------------------------------- | ----------------------------------------
esf-utl-1.1 | It should implement logging | log
esf-utl-1.2 | It should simplify error handling inside Promises | promiseReject (depr. since API v.2.0)
esf-utl-1.3 | It should basic path operations | stripSlash, absolutizePath
esf-utl-1.4 | Console messages should be clear | styles
esf-utl-1.5 | It should filter confidential information off logs | logFilter
esf-utl-1.6 | Capitalization mtd, compatible with DB Class naming convention | capitalize
esf-utl-1.7 | Generation of current date in cross-FS-friendly format | getCurrentDateFmtFFS
esf-utl-1.8 | It should handle Errors with options: set number, custom message, custom Error, an option to throw | rejectingError
esf-utl-2.0 | Implement API v.2.0 | _
esf-utl-2.1 | Implement actual ESF-spec (v.2.5), update to babel v.6 | _
esf-utl-2.2 | Add basic tests for all methods | _
esf-utl-3.0 | It should have a method to stringify JSON with circular structures | stringifyJSON
esf-utl-4.0 | It should clearly show log file name, log string should be shorter |
esf-utl-5.0 | It should present short aliases for log() and rejectingError methods | l, e

API v.3.0

``js
static object logFile // path to log file. Default: ${os.tmpdir()}/e.log
static object styles
static string getCurrentDateFmtFFS() // current Date-Time formatted like 0000-00-00_00-00-00
static string stripSlash(string pathName) // strips ending slash off a path string
static string absolutizePath(string p, string rel) //
static string logFilter(string s) //
static void log(string msg, string style, bool silent) //
static Error rejectingError( //
integer num, // error number
string msg, // error message
Error err, // error object
Function rej, // Promise rejection callback handler
boolean thr // throw setter. If true the Error err should be thrown, else - just returned
)
static string capitalize(string s) //
static string stringifyJSON(object s) // Stringifies an object, stripping off circular structures
static void l // alias of log
static Error e // alias of rejectingError
``

--------------------------------------------------------------------------------

© MIT bondden 2009-2016