Class: sesajstools/utils/array

sesajstools/utils/array()

new sesajstools/utils/array()

Collection de fonctions génériques pour manipuler des tableaux

Source:

Methods

filterArray(arg) → {Array}

Retourne le tableau passé en argument ou un tableau vide si l'argument n'était pas un Array

Parameters:
Name Type Description
arg Array

L'array à controler
Source:
Returns:
Type
Array

filterArrayInt(arg, strictopt) → {Array}

Retourne le tableau passé en argument ou un tableau vide si l'argument n'était pas un Array
Tous les éléments qui ne sont pas des entiers positifs (0 accepté) seront éliminés

Parameters:
Name Type Attributes Default Description
arg Array

L'array à controler
strict boolean <optional>
 true
Source:
Returns:
Type
Array

filterArrayString(arg, strict) → {Array}

Retourne le tableau passé en argument ou un tableau vide si l'argument n'était pas un Array
Tous les éléments qui ne sont pas des strings seront éliminés

Parameters:
Name Type Description
arg Array

L'array à controler
strict boolean

passer false pour ajouter un toString sur tous les éléments qui ont la méthode
Source:
Returns:
Type
Array

filterBoolean(arg) → {boolean}

Retourne false pour 'false' et '0' et un cast en Boolean sinon

Parameters:
Name Type Description
arg *
Source:
Returns:
Type
boolean

filterDate(arg) → {Date|undefined}

Retourne un objet Date (on tente un cast si on nous fourni une string ou un entier) ou undefined

Parameters:
Name Type Description
arg
Source:
Returns:
Type
Date | undefined

filterInt(arg) → {number}

Retourne l'entier positif fourni ou 0

Parameters:
Name Type Description
arg number | string
Source:
Returns:
Type
number

filterObject(obj, excludeFilteropt) → {object}

Retourne un object éventuellement filtré, vide si autre chose qu'un plain object est fourni
(Date, Array, etc, sont transformés en objets vides, mais ces types sont préservés dans le contenu de l'objet passé)
L'objet retourné est cloné, ses objets enfants aussi sauf ceux qui ne sont pas des objets littéraux
pour lesquels ça reste une référence (pour des valeurs de type Date, Array & co)

Parameters:
Name Type Attributes Description
obj *
excludeFilter RegExp | function <optional>

si regexp elle sera testée sur les propriétés pour les filtrer,
si function elle sera appelée avec (propriété, valeur) et devra renvoyer true pour exclure
Source:
Returns:

Un nouvel objet issu de obj filtré (ou obj si on a pas fourni de excludeFilter)

Type
object

filterString(arg) → {string}

Retourne la chaine passée en argument, un cast en string si ça existe pour le type ou une chaine vide sinon

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

(static) exports(obj, indent) → {*}

dump un objet de manière plus complète qu'un stringify

Parameters:
Name Type Description
obj
indent
Source:
Returns:
Type
*