jsdoc util

util

Utilidades varias.

Métodos

esIndefinido(expr)

Determina si una expresión es indefinida o no.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
expr	*	Expresión a evaluar.

Devuelve: boolean

esCadena(expr)

Determina si una expresión es una cadena.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
expr	*	Expresión a evaluar.

Devuelve: boolean

esArray(obj)

Determina si un objeto es un array.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
obj	*	Objeto a evaluar.

Devuelve: boolean

esObjeto(obj)

Determina si un objeto es estrictamente un objeto (está definido y no es un array).

Parámetro	Tipo	Descripción	Opcional	Predeterminado
obj	*	Objeto a evaluar.

Devuelve: boolean

esComponente(obj)

Determina si un objeto es un componente.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
obj	*	Objeto a evaluar.

Devuelve: boolean

esExpresionRegular(obj)

Determina si un valor es una expresión regular.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
obj	*	Valor a evaluar.

Devuelve: boolean

esElemento(obj)

Determina si un valor es un elemento del DOM (Node o Element).

Parámetro	Tipo	Descripción	Opcional	Predeterminado
obj	*	Valor a evaluar.

Devuelve: boolean

esListaDeElementos(obj)

Determina si un valor es una lista de elementos del DOM (NodeList o HTMLCollection).

Parámetro	Tipo	Descripción	Opcional	Predeterminado
obj	*	Valor a evaluar.

Devuelve: boolean

obtenerPropiedad(objeto,ruta)

Busca una propiedad anidada dada su ruta separada por puntos.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
objeto	Object	Objeto.
ruta	string	Ruta a evaluar.

Devuelve: *|undefined

asignarPropiedad(objeto,ruta,valor)

Asigna el valor a una propiedad anidada dada su ruta separada por puntos.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
objeto	Object	Objeto.
ruta	string	Ruta a evaluar.
valor	*	Valor a asignar.

completarIzquierda(cadena,longitud[,completar])

Completa la cadena por la izquierda (pad left).

Parámetro	Tipo	Descripción	Opcional	Predeterminado
cadena	string	Cadena a procesar.
longitud	number	Longitud deseada.
completar	string	Caracter o cadena de relleno.	Si	" "

completarDerecha(cadena,longitud[,completar])

Completa la cadena por la derecha (pad right).

Parámetro	Tipo	Descripción	Opcional	Predeterminado
cadena	string	Cadena a procesar.
longitud	number	Longitud deseada.
completar	string	Caracter o cadena de relleno.	Si	" "

minutosAHoras(valor[,string])

Convierte una cantidad de minutos (entero) a horas y minutos.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
valor	number	Minutos desde las 0:00.
string	boolean	Si es true, devolverá un string H:mm. De lo contrario, devolverá un array [H,m].	Si	true

Devuelve: string|number[]

segundosAHoras(valor[,devolverSegundos,string])

Convierte una cantidad de segundos a horas y minutos.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
valor	number	Segundos desde las 0:00:00.
devolverSegundos	boolean	Devolver los segundos.	Si	false
string	boolean	Si es true, devolverá un string H:mm, o H:mm:ss si segundos es true. De lo contrario, devolverá un array [H,m,s].	Si	true

Devuelve: string|number[]

horasAMinutos(hora)

Convierte una hora en formato horas:minutos a un entero representando la cantidad de minutos desde las 0:00.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
hora	string	Hora a analizar.

Devuelve: number|null

horasASegundos(valor)

Convierte una hora en formato horas:minutos[:segundos] a un entero representando la cantidad de segundos desde las 0:00.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
valor	string	Hora a analizar.

Devuelve: number|null

epochAMinutos(fecha)

Obtiene la cantidad de minutos desde las 0:00 de la fecha epoch especificada.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
fecha	number	Fecha a analizar.

Devuelve: number

epochAFecha(tiempo)

Convierte una fecha epoch a un objeto Date.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
tiempo	number	Tiempo epoch.

Devuelve: Date

diasEntre(a,b)

Devuelve la cantidad de días transcurridos entre dos fechas.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
a
b

validarFecha(valor)

Verifica si el valor dado es una fecha válida.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
valor	*	Valor a analizar.

Devuelve: boolean

cadenaAzar()

Genera y devuelve una cadena de caracteres al azar.
Devuelve: string

trim(cadena,caracteres)

Trim con expresión regular.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
cadena	string	Cadena.
caracteres	string	Caracteres (debe se compatible con expresiones regulares, escapando los caracteres necesarios).

Devuelve: string

esObjetoVacio(obj)

Determina si el valor dado es un objeto vacío.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
obj	*	Valor a evaluar.

Devuelve: boolean

archivoADataUrl(archivo,retorno)

Convierte un archivo a una cadena (Data URL).

Parámetro	Tipo	Descripción	Opcional	Predeterminado
archivo	File	Archivo.
retorno	function	Función de retorno.

azar(min,max)

Devuelve un entero aleatoreo en el rango dado.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
min	number	Mínimo.
max	number	Máximo.

Devuelve: number

nombreDirectorio(ruta)

Devuelve el directorio donde se encuentra el archivo especificado. Siempre incluye / al final.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
ruta	string	Ruta a analizar.

Devuelve: string

hexARgba(hex)

Dado un color en hexagesimal en formato #RRGGBB, #RRGGBBAA, #RGB o #RGBA, devuelve un objeto con sus componentes RGB y Alpha.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
hex

hexARgb(hex)

Dado un color en hexagesimal en formato #RRGGBB, #RRGGBBAA, #RGB o #RGBA, devuelve un objeto con sus componentes RGB y Alpha.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
hex

rgbaAString(color)

Convierte y devuelve la representación CSS del color.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
color

separarUnaVez(cadena,delimitador)

Separa la cadena por el delimitador solo una vez, aunque el delimitador vuelva a aparecer posteriormente.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
cadena
delimitador

separarGrupos(delimitadorComienzo,delimitadorFinal,cadena,escape)

Divide una cadena por dos delimitadores (comienzo y fin) siempre y cuando estén emparejados y no estén escapados (no tiene en cuenta la presencia de comillas).

Parámetro	Tipo	Descripción	Opcional	Predeterminado
delimitadorComienzo
delimitadorFinal
cadena
escape

procesarValores(data)

Procesa una cadena o un array de cadenas y los convierte a sus tipos correspondientes.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
data

validarEmail(v)

Valida una dirección de email.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
v

nl2br(t)

Convierte los saltos de línea en <br>.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
t

periodo(v,format)

Genera la descripción de un período de tiempo.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
v
format

tamanoArchivo(bytes,si)

Convierte bytes a formato legible.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
bytes
si

obtenerSegundosZonaHoraria()

Devuelve la diferencia UTC en segundos.

fecha(d,f)

Convierte una fecha a string. La salida será UTC.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
d
f

fechaHora(v,f)

Convierte una fecha a cadena, incluyendo horas y minutos. La salida será UTC. Esta función es alias de this.dateToString(v,f) con distinto valor predeterminado para f.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
v
f

fechaLocal(d,f)

Convierte una fecha a cadena. La salida se convertirá a hora local.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
d
f

fechaHoraLocal(v,f)

Convierte una fecha a string, incluyendo horas y minutos. La salida se convertirá a hora local. Esta función es alias de this.dateToStringLocal(v,f) con distinto valor predeterminado para f.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
v
f

cadenaAFecha(v)

Convierte un string representando una fecha en formato d/m/Y H:i:s o Y-m-d H:i:s a un objeto Date.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
v

cadenaAEpoch(v)

Convierte un string representando una fecha en formato d/m/Y H:i:s (se asume UTC) a tiempo epoch.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
v

convertirAFecha(v)

Convierte una fecha a un objeto Date, autodetectando su formato.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
v

convertirAEpoch(v)

Convierte una fecha a tiempo epoch, autodetectando su formato.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
v

fechaAEpoch(d)

Convierte un objeto Date a tiempo epoch (UTC).

Parámetro	Tipo	Descripción	Opcional	Predeterminado
d

epoch()

Devuelve el tiempo epoch actual (UTC).

epochLocal()

Devuelve el tiempo epoch actual (zona local).

epochAUtc(v)

Convierte un epoch local a UTC.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
v

epochALocal(v)

Convierte un epoch UTC a local.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
v

medianoche(d)

Devuelve un objeto Date a las 0:00 (local) del día de la fecha especificada.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
d

formatoNumero(v,decimalPlaces)

Trunca y formatea a string un número a la cantidad de decimales.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
v
decimalPlaces

redondear(v,decimalPlaces)

Trunca un número a la cantidad de decimales manteniendo el tipo.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
v
decimalPlaces

recorrerSinRecursion(arr,prop,fn,afterFn,par)

Recorre un array de objetos multidimensional sin recursión (utilizando una pila) para mayor eficiencia.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
arr
prop
fn
afterFn
par

buscar(arr,prop,val,returnIndex)

Permite buscar un elemento de un array de objetos comparando por una propiedad determinada.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
arr
prop
val
returnIndex

extraerObjetos(listado,propiedad)

Dado un listado de objetos, devuelve un objeto {propiedad:objeto,...} (donde propiedad es el valor de la propiedad especificada de cada elemento). Nótese que si un objeto no presenta la propiedad, no está asignada o es nula, será omitido.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
listado	Object[]	Listado de objetos a procesar.
propiedad	string	Nombre de la propiedad a utilizar como claves del nuevo objeto.

buscarElemento(array,buscar)

Busca un elemento del array.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
array	*[]	Array.
buscar	*	Valor a buscar por coincidencia exacta, o expresión regular.

Devuelve: number|null

removerElemento(array,buscar)

Busca y remueve un elemento del array.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
array	*[]	Array.
buscar	*	Valor a buscar por coincidencia exacta, o expresión regular.