-
Notifications
You must be signed in to change notification settings - Fork 2
jsdoc util
Utilidades varias.
Determina si una expresión es indefinida o no.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
expr |
* |
Expresión a evaluar. |
Devuelve: boolean
Determina si una expresión es una cadena.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
expr |
* |
Expresión a evaluar. |
Devuelve: boolean
Determina si un objeto es un array.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
obj |
* |
Objeto a evaluar. |
Devuelve: boolean
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
Determina si un objeto es un componente.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
obj |
* |
Objeto a evaluar. |
Devuelve: boolean
Determina si un valor es una expresión regular.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
obj |
* |
Valor a evaluar. |
Devuelve: boolean
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
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
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
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. |
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 | " " |
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 | " " |
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[]
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[]
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
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
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
Convierte una fecha epoch a un objeto Date.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
tiempo |
number |
Tiempo epoch. |
Devuelve: Date
Devuelve la cantidad de días transcurridos entre dos fechas.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
a |
||||
b |
Verifica si el valor dado es una fecha válida.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
valor |
* |
Valor a analizar. |
Devuelve: boolean
Genera y devuelve una cadena de caracteres al azar.
Devuelve: string
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
Determina si el valor dado es un objeto vacío.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
obj |
* |
Valor a evaluar. |
Devuelve: boolean
Convierte un archivo a una cadena (Data URL).
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
archivo |
File |
Archivo. | ||
retorno |
function |
Función de retorno. |
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
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
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 |
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 |
Convierte y devuelve la representación CSS del color.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
color |
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 |
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 |
Procesa una cadena o un array de cadenas y los convierte a sus tipos correspondientes.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
data |
Valida una dirección de email.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
v |
Convierte los saltos de línea en <br>
.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
t |
Genera la descripción de un período de tiempo.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
v |
||||
format |
Convierte bytes a formato legible.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
bytes |
||||
si |
Devuelve la diferencia UTC en segundos.
Convierte una fecha a string. La salida será UTC.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
d |
||||
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 |
Convierte una fecha a cadena. La salida se convertirá a hora local.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
d |
||||
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 |
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 |
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 |
Convierte una fecha a un objeto Date
, autodetectando su formato.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
v |
Convierte una fecha a tiempo epoch, autodetectando su formato.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
v |
Convierte un objeto Date a tiempo epoch (UTC).
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
d |
Devuelve el tiempo epoch actual (UTC).
Devuelve el tiempo epoch actual (zona local).
Convierte un epoch local a UTC.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
v |
Convierte un epoch UTC a local.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
v |
Devuelve un objeto Date
a las 0:00 (local) del día de la fecha especificada.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
d |
Trunca y formatea a string un número a la cantidad de decimales.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
v |
||||
decimalPlaces |
Trunca un número a la cantidad de decimales manteniendo el tipo.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
v |
||||
decimalPlaces |
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 |
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 |
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. |
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
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. |
¿Probaste Foxtrot? Contanos qué te pareció 🥰 contacto@foxtrot.ar
Índice
Primeros pasos
Gestor de aplicaciones
Editor de vistas
Componentes
Módulos
Comunicación cliente<->servidor
Modelo de datos - ORM
PHPDOC
JSDOC
☝ Comentarios
🤷♂️ Dudas
🤓 Ayuda
⌨ Contribuciones
Escribinos: contacto@foxtrot.ar