Class: log

log(message, objectToDumpopt, filteropt, optionsopt)

new log(message, objectToDumpopt, filteropt, optionsopt)

Méthode qui écrit en console si l'on est pas en prod (ne fait rien en prod)

Parameters:
Name Type Attributes Description
message string | object
objectToDump Object <optional>

Un objet éventuel qui sera rendu en json avec indentation
filter string <optional>

Un nom de filtre pour exclusion éventuelle
options Object <optional>

Passer les propriétés facultatives
indent pour indenter objectToDump du nombre d'espaces demandés,
max pour modifier la limite de la sortie (200 par défaut)
Source:

Members

(static) error

Ajoute un message (avec éventuellement le dump d'un objet) dans le log d'erreur (config.logs.error)

Source:

Methods

addError(ressource, error)

Ajoute une erreur à la ressource (en créant le tableau $errors s'il n'existait pas)

Parameters:
Name Type Description
ressource Ressource
error string
Source:

addWarning(ressource, warning)

Ajoute un warning à la ressource

  • crée le tableau $warnings s'il n'existait pas
  • n'ajoute rien si le warning y était déjà
Parameters:
Name Type Description
ressource Ressource
warning string
Source:

basicArrayIndexer(values) → {null|Array}

Retourne values purgé de null|undefined si c'est un tableau non vide, null sinon

Parameters:
Name Type Description
values Array
Source:
Returns:
Type
null | Array

ensure(value, type, defaultValue) → {*}

Garanti que le retour sera du type demandé, mis à defaultValue (lui ne sera pas casté) si falsy

Parameters:
Name Type Description
value *
type string

string|number|integer|boolean
defaultValue *
Source:
Returns:
Type
*

getNormalizedGrabOptions(optionsopt) → {Object}

Normalise {skip, limit} et le retourne

Parameters:
Name Type Attributes Description
options Object <optional>
Properties
Name Type Attributes Description
limit number <optional>
skip number <optional>
Source:
Returns:
Type
Object

getNormalizedName(nom, strictopt) → {string}

Callback de normalisation de string (utilisé pour l'index du nom d'un groupe)

Parameters:
Name Type Attributes Default Description
nom string
strict boolean <optional>
 true

passer false pour renvoyer une chaîne vide plutôt que throw en cas de nom invalide
Source:
Throws:

si strict et nom invalide (pas une string ou retournerait une chaîne vide après normalisation)

Type
Error
Returns:

Le nom sans caractères autres que [a-z0-9]

Type
string

getRidEnfants(arbre) → {Array}

Retourne les rid de tous les enfants

Parameters:
Name Type Description
arbre
Source:
Returns:
Type
Array

isEntity(obj, entityNameopt) → {boolean}

Vérif basique que obj est bien une Entity entityName (si entityName n'est pas fourni
ça renvoie true si obje est une entity Lassi)

Parameters:
Name Type Attributes Description
obj Object
entityName string <optional>
Source:
Returns:
Type
boolean

isSameSimpleArray(ar1, ar2) → {boolean}

Retourne true si ar1 et ar2 ont autant d'élément tous égaux (comparaison ===)

Parameters:
Name Type Description
ar1 Array
ar2 Array
Source:
To Do:
  • déplacer ça dans sesajstools
Returns:
Type
boolean

(static) dataError(message, objectToDump, filter)

Ajoute un message (avec éventuellement le dump d'un objet) dans le log d'erreur de données (config.logs.dataError)

Parameters:
Name Type Description
message
objectToDump
filter
Source:

(static) debug(message, objectToDump, filteropt, options)

Écrit dans le fichier config.logs.debug s'il est précisé (ne fait rien sinon)

Parameters:
Name Type Attributes Description
message
objectToDump
filter <optional>
options
Source:

(static) disable()

Rend log() muet

Source:

(static) enable()

Rend log() bavard

Source:

(static) exclude(filter)

Active un filtre (le créé si besoin)

Parameters:
Name Type Description
filter string

Le filtre à appliquer (pour exclure les messages qui le contiennent)
Source:

(static) ifError(erroropt)

log.error si error, rien sinon

Parameters:
Name Type Attributes Description
error Error | string <optional>
Source:

(static) include(filter)

Désactive un filtre

Parameters:
Name Type Description
filter string

Le filtre à enlever (les messages qui le contiennent redeviennent actifs)
Source:

(static) perf(response, strToAdd, noTimeropt)

Ajoute une chaine avec un timer (depuis la réception de la requete) au message de perf courant
S'active dans la conf (config.logs.perf), sinon ne fait rien

Parameters:
Name Type Attributes Default Description
response
strToAdd
noTimer boolean <optional>
 false

passer true pour ne pas ajouter la mesure de temps
Source:

(static) out(response)

Clos la mesure de perf pour cette requête et écrit dans le log

Parameters:
Name Type Description
response Object

L'objet response d'express, on traitera response.perf.msg si response.perf existe
Source:

(static) encadre(int, min, max, label) → {Integer}

Vérifie qu'une valeur est entière dans l'intervalle donné et recadre sinon (avec un message dans le log d'erreur)

Parameters:
Name Type Description
int

La valeur à contrôler
min

Le minimum exigé
max

Le maximum exigé
label

Un label pour le message d'erreur (qui indique ce qui a été recadré)
Source:
Returns:
Type
Integer

(static) idListToArray(list) → {Array.<string>}

Transforme une liste en tableau de mots valides pour des ids ([A-Za-z0-9_-])

Parameters:
Name Type Description
list string
Source:
Returns:

la liste des ids récupérés (tous les caractères autres que lettres, chiffres, tiret et underscore ont été virés)

Type
Array.<string>

(static) isApi(url) → {boolean}

Retourne true si l'url contient /api/

Parameters:
Name Type Description
url
Source:
Returns:
Type
boolean

(static) isPublic(url) → {boolean}

Retourne true si l'url concerne une url publique (avec /public/ dedans, html ou json)

Parameters:
Name Type Description
url
Source:
Returns:
Type
boolean

(static) isStatic(url) → {boolean}

Retourne true si l'url concerne un fichier statique
(statique i.e. les extensions susceptibles d'exister dans sesatheque, c'est pas exaustif)

Parameters:
Name Type Description
url
Source:
Returns:
Type
boolean

Génère le code html d'un lien

Parameters:
Name Type Attributes Description
path

Le path (absolu ou relatif)
texte

Le texte à afficher
args string | Array <optional>

Des arguments à ajouter au path (séparateur slash)
Source:
Returns:

Le code html du tag a

Type
string

(static) linkQs(path, texte, argsopt) → {string}

Génère le code html d'un lien avec les args en queryString

Parameters:
Name Type Attributes Description
path

Le path (absolu ou relatif)
texte

Le texte à afficher
args Object <optional>

Des arguments à ajouter en queryString
Source:
Returns:

Le code html du tag a

Type
string

(static) sanitizeHashKey(source) → {string}

Remplace les espaces par des underscores et vire les caractères de contrôle d'une chaine (\n compris)

Parameters:
Name Type Description
source string

La chaîne à nettoyer
Source:
See:
Returns:

La chaîne nettoyée

Type
string

(static) sanitizeStrict(source) → {void|*|Object|string|XML}

Vire tous les caractères autres que lettres (non accentuées), chiffres, _ et -

Parameters:
Name Type Description
source
Source:
Returns:
Type
void | * | Object | string | XML

(static) strFormat(message, args) → {string}

Incorpore des arguments à un message, façon sprintf
pas très intéressant si n arguments, util.format fait la même chose, mais tolère un tableau d'arguments en 2e param

Parameters:
Name Type Description
message string
args string | Array

Les arguments, en liste ou en tableau
Source:
Returns:
Type
string

(static) stripTags(source) → {string}

Elimine les tags html d'une string

Parameters:
Name Type Description
source string
Source:
Returns:
Type
string

(static) toDate(value) → {Date}

Converti un timestamp ou un chaine en objet Date

Parameters:
Name Type Description
value number | string | Date

Un timestamp (en ms ou s) ou une chaine ('DD/MM/YYYY' ou ISO_8601)
Source:
Returns:

L'objet Date ou undefined si la conversion a échoué (value invalide)

Type
Date

(static) toJour(date) → {string}

Formate un objet Date en DD/MM/YYYY

Parameters:
Name Type Description
date Date
Source:
Returns:

Le jour au format DD/MM/YYYY

Type
string