Leukos-Tech-JsUtils

Insieme di utilità suddivise in categorie di applicazione.

Package per npm.

Sommario

* Installazione
* Contenuto del package
* leukos-tech.jsutils.io
* copyObj(object, safeJson=false)
* leukos-tech.jsutils.json
* safeJsonData(key, value)
* leukos-tech-jsutil.log
* logString(message, addTimestamp=true)
* errString(message, err, addTimestamp=true)
* leukos-tech.jsutils.errors
* errStackParser(err, meaningIndex=1)
* stackParser(stack, meaningIndex=1)
* getStack()
* leukos-tech-jsutils.ancestors
* LoggedClass - (class)
* leukos-tech-jsutils.custErrors
* args
* MissingArgError - (class)
* WrongArgTypeError - (class)
* leukos-tech-jsutils.tests
* getHeaderString(headerString, delimiter, spacer, delta, extra)
* getHeader(header, level)
* TimingResults - (class)
* leukos-tech-jsutils.decorators
* cacheIt(method, enabled)
* leukos-tech-jsutils.validators
* validateObject(inspected, cfrData)
Estensione dei types* di base
* String
* String.prototype.replaceAll(str1, str2, ignore)

Installazione

``bash
$ npm install leukos-tech-jsutils --save
`

Contenuto del package

Di seguito l'elenco degli oggetti contenuti nel package.

leukos-tech-jsutils.io

Oggetto contenente funzioni dedicate all'I/O (lettura, scrittura, copia, etc)

$3

Crea una copia dell'oggetto (json-parsable) fornito come 1° argomento

#### Argomenti

object {Object} Oggetto da copiare (deve essere json-parsable*).
safeJson {Boolean} Se false (default*) copia l'oggetto così come è. Altrimenti applica il filtro in leukos-tech-jsutils.json.safeJsonData() (Vai alla documentazione).

#### Tipi Restituiti

* copied {Object} La copia dell'oggetto fornito, indipendente dall'oggetto originario (modificando i valori dell'uno l'altro rimane invariato).


#### Utlizzo:

`javascript
const {copyObj} = require('leukos-tech-jsutils').io;
// Require dell'oggetto

let independent_copy = copyObj(object_to_copy, false);
// Restituisce una copia dell'oggetto

let independent_copy = copyObj(object_to_copy, true);
// Restituisce una copia dell'oggetto in cui i campi sensibili sono stati alterati
`

Torna al Sommario

---

leukos-tech-jsutils.json

Oggetto contenente funzioni dedicate all'oggetto JSON.

$3

Filtro da utilizzare come 2° argomento per la funzione JSON.stringify(object, replacer). Sanitizza proprietà dell'oggetto fornito come argomento contenenti dati sensibili (come le password).

#### Argomenti

* key {String} Chiave corrente

* value {any} Valore associato alla chiave, eventualmente da sanitizzare se la chiave è inclusa tra le regole di sanitizzazione.

#### Tipi restituiti

* filteredValue {any} Il valore intonso, se la chiave non ricade tra quelle da sanitizzare, o il valore sanitizzato.


#### Utilizzo

`javascript
const {safeJsonData} = require('leukos-tech-jsutils').json;

let cleanObj = JSON.stringify(some_object, safeJsonData);
`


#### Comportamento

Per campi identificati dalle chiavi:

* password
* pwd
* passkey
* passphrase

restituisce "\\\\\\\\\\\*" invece del valore originale

Torna al Sommario


---

leukos-tech-jsutils.log

Oggetto contenente funzioni di utilità per il logging

$3

Aggiunge al messaggio info utili al logging come il nome del file del modulo, il nome della funzione, il numero di riga, etc.

#### Argomenti

* message {String} Messaggio da loggare

addTimestamp {Boolean} Se true (default*) aggiunge il timestamp a inizio della riga

#### Tipi restituiti

* toLogger {String} Stringa pronta per essere passata al logger.

Torna al Sommario

___

$3

Aggiunge al messaggio info utili al logging come il nome del file del modulo, il nome della funzione, il numero di riga, etc. e quelle di base dell'errore (message e name)

#### Argomenti

* message {String} Messaggio da loggare

* err {Object} Derivato di Error da cui estrapolare name e message.

addTimestamp {Boolean} Se true (default*) aggiunge il timestamp a inizio della riga

#### Tipi restituiti

* toLogger {String} Stringa pronta per essere passata al logger.

Torna al Sommario

___

leukos-tech-jsutils.errors

Contiene funzioni dedicate agli errori e alla loro gestione

$3

Estrapola lo stack dell'oggetto fornito come argomento err. Wrapper di errors.stackParser().

#### Argomenti

* err {Object} Oggetto da cui estrapolare la proprietà .stack {String}.

* meaningIndex {Number} Indice iniziale per i dati significativi da estrapolare dalla stringa stack (elimina quelli precedenti).mUna volta trasformato in array esegue il metodo Array.splice(0, meaningIndex) per rimuovere da esso dati spuri dovuti all'elaborazione.

#### Tipi Restituiti:

stackData {StackObject}, oggetto con le seguenti proprietà:

* meaning {StackData} Oggetto contenente le proprietà per il livello più alto della stack (secondo le proprietà file, func, line, col)

caller {StackData} Oggetto contenente le proprietà del livello caller* (secondo le proprietà file, func, line, col))

* lower {Array} Array di oggetti StackData a ritroso per la stack

Torna al Sommario

___

$3

Effettua il parsing della stringa di stack fornita come argomento.

#### Argomenti

* stack {String} Stack di cui effettuare il parsing

* meaningIndex {Number} Indice iniziale per i dati significativi da estrapolare dalla stringa stack (elimina quelli precedenti). Una volta trasformato in array esegue il metodo Array.splice(0, meaningIndex) per rimuovere da esso dati spuri dovuti all'elaborazione.

#### Tipi Restituiti:

stackData {StackObject}, oggetto con le seguenti proprietà:

* meaning {StackData} Oggetto contenente le proprietà per il livello più alto della stack (secondo le proprietà file, func, line, col)

caller {StackData} Oggetto contenente le proprietà del livello caller* (secondo le proprietà file, func, line, col))

* lower {Array} Array di oggetti StackData a ritroso per la stack

Torna al Sommario

___

$3

Restituisce l'oggetto StackObject dell'istante in cui viene chiamata sollevando una eccezione fittizia ed utilizzando su di essa la funzione stackParser().

#### Tipi Restituiti:

stackData {StackObject}, oggetto con le seguenti proprietà:

* meaning {StackData} Oggetto contenente le proprietà per il livello più alto della stack (secondo le proprietà file, func, line, col)

caller {StackData} Oggetto contenente le proprietà del livello caller* (secondo le proprietà file, func, line, col))

* lower {Array} Array di oggetti StackData a ritroso per la stack


Torna al Sommario

___

leukos-tech-jsutils.ancestors

Package di Classi ancestor da ereditare per implementare funzionalità specifiche negli oggetti.

$3

Classe Ancestor per fornire a quelle che la ereditano funzionalità native di logging.

Ognuna delle classi child possiederà i metodi:

* ._debug(message)
* ._info(message)
* ._warn(message)
* ._error(message)


Le classi che la ereditano devono prevedere, nel proprio costruttore, gli argomenti:

* debugEnabled {Boolean}
loggerInstance {Object} (opzionale*)
loggerLevel {Number} (opzionale*)

da fornire al costruttore di LoggedClass tramite

`javascript
super(debugEnabled, loggerInstance, loggerLevel);
`
Torna al Sommario

___

leukos-tech-jsutils.custErrors

Package di classi Errore personalizzate da utilizzare nei progetti Leukos-Tech.

leukos-tech-jsutils.custErrors.args

Errori relativi agli argomenti delle funzioni

$3

Un argomento necessario allo svolgimento della funzione non è stato fornito

#### Costruttore

`javascript
new MissingArgError(argName {String})
`

Torna al Sommario

$3

Un argomento è stato fornito del tipo sbagliato

#### Costruttore

`javascript
new WrongArgTypeError(argName{String}, value{Any}, expected{Any})
`

Torna al Sommario


___

leukos-tech-jsutils.tests

Utilità focalizzate sullo unittesting.

$3

Genera una stringa grafica con l'header sulla sinistra e una serie di carateri ai lati.

#### Argomenti

headerString {String} Stringa da utilizzare come header*
* delimiter {String} Carattere da utilizzare al principio e fine della stringa generata (Delimitatore)
* spacer {String} Carattere da utilizzare per riempire la stringa ai lati dell'headerString
* delta {Number} Numero di char di rientro laterale (default=0) (Viene moltiplicato per una costante - 2).
* extra {String} Caratteri extra da aggiungere al termine della stringa (generalmente \n per spaziature verticali)

#### Tipi restituiti

graphicString {String} Stringa da utilizzare come header per le funzioni describe() di unittesting*

Se process.env.DEBUG è true o 1 aggiunge un \n all'inizio della stringa per aumentare la spaziatura verticale

Torna al Sommario

___

$3

Restituisce una stringa grafica per l'header fornito, in base al preset selezionato

#### Argomenti

* header {String} Stringa con l'header
* level {Number} Identificativo del tipo di formattazione (default=2)


#### Tipi restituiti

graphicString {String} Stringa da utilizzare come header per le funzioni describe() di unittesting*

Se process.env.DEBUG è true aggiunge un \n all'inizio della stringa per aumentare la spaziatura verticale

#### Valori di level e corrispettive formattazioni

* 0 > |========