Este README proporciona una descripción y ejemplos de uso de las funciones disponibles en este paquete.
Convierte un valor en un número, con la opción de proporcionar un valor predeterminado en caso de error.
value(any): El valor que se intentará convertir en un número.def(number, opcional, por defecto 0): El valor predeterminado que se utilizará si la conversión falla o no se proporciona.
const result = parseNumber("42");
console.log(result); // Resultado: 42
const resultWithDefault = parseNumber("texto no numérico", 100);
console.log(resultWithDefault); // Resultado: 100Hook personalizado que proporciona el tamaño de la ventana del navegador en tiempo real.
WindowSize | undefined: El objeto que contiene el ancho (width) y el alto (heigth) de la ventana o undefined si el hook no se ha inicializado todavía.
import useWindowSize from './useWindowSize';
function MyComponent() {
const windowSize = useWindowSize();
if (windowSize) {
console.log(`Ancho: ${windowSize.width}, Alto: ${windowSize.height}`);
} else {
console.log('El tamaño de la ventana no se ha inicializado todavía.');
}
}Convierte un valor en una cadena de texto o devuelve un valor predeterminado si no es una cadena o es un objeto vacío.
value(any): El valor que se desea convertir a una cadena de texto.defaultValue(string, opcional): El valor predeterminado que se retornará si value no es una cadena o es un objeto vacío.
import toString from './toString';
const result = toString(42);
console.log(result); // Resultado: "42"
const resultWithDefault = toString({}, "Valor predeterminado");
console.log(resultWithDefault); // Resultado: "Valor predeterminado"Hook personalizado para gestionar valores en el almacenamiento local (localStorage) de manera segura.
key(string): Clave para identificar el valor en localStorage.initialValue(T): Valor inicial que se utilizará si no se encuentra ningún valor en localStorage.
[T, (value: T) => void]: Un array con dos elementos: el valor actual y una función para actualizar el valor.
import useLocalStorage from './useLocalStorage';
function MyComponent() {
const [storedValue, setStoredValue] = useLocalStorage('myKey', 'default');
// Para obtener el valor almacenado
console.log(storedValue);
// Para actualizar el valor almacenado
setStoredValue('nuevoValor');
}Crea un vector (Array) del tipo de dato especificado.
array(T[] | void): Vector (Array).
T[]: Vector (Array) del tipo especificado.
const array = toArray([1, 2, 3]);
console.log(array); // Resultado: [1, 2, 3]
const emptyArray = toArray();
console.log(emptyArray); // Resultado: []Dada una cadena, reemplaza en dicha cadena el valor de oldValue por el valor de newValue.
value(string | null | undefined): Cadena de caracteres.oldValue(string): Valor antiguo a ser reemplazado por uno nuevo.newValue(string): Valor nuevo que tomará el lugar del valor antiguo.
string: Cadena de caracteres con ocurrencias reemplazadas.
const originalString = "Hoy es un día soleado y hoy es genial.";
const replacedString = replaceAll(originalString, "hoy", "mañana");
console.log(replacedString);
// Resultado: "Mañana es un día soleado y mañana es genial."Dada una cadena de fecha con formato ISO 8601, elimina de dicha cadena las apariciones de "T" y "Z".
date(string): Cadena con formato de fecha.
string: Cadena con formato fecha YYYY-MM-DD HH:mm:ss.
const isoDate = "2023-10-16T08:30:00Z";
const formattedDate = dateToStr(isoDate);
console.log(formattedDate); // Resultado: "2023-10-16 08:30:00"Dada una fecha en formato ISO 8601, transforma la fecha de formato ISO 8601 a "DD-MM-YYYY HH:MM:sss". El formato de salida dependerá de los parámetros que reciba la función.
fecha(Date | null | undefined): Fecha de tipo Date con formato ISO 8601.includeTime(boolean, opcional, por defecto true): True si el formato de salida incluye tiempo "HH:MM", False si no incluye "HH:MM".format("-" | "/", opcional, por defecto "/"): Carácter divisor de fecha, puede ser "DD-MM-YYYY HH:MM" o "DD/MM/YYYY HH:MM".days(number, opcional, por defecto 0): Cantidad de días que serán sumados o restados a los días de la fecha.includeSeconds(boolean, opcional, por defecto false): True si el formato de salida incluye tiempo ":sss", False si no incluye ":sss".
string: Cadena de fecha con formato "DD-MM-YYYY HH:MM:sss" en su forma extendida, "DD-MM-YYYY" en su forma reducida.
const isoDate = "2023-10-16T08:30:00Z";
const formattedDate = formatContructorDate(new Date(isoDate));
console.log(formattedDate); // Resultado: "16-10-2023 08:30:00"Dada una fecha en formato ISO 8601, transforma la fecha de formato ISO 8601 a "DD-MM-YYYY HH:MM:sss". El formato de salida dependerá de los parámetros que reciba la función.
isoDate(string, opcional): Cadena de fecha con formato ISO 8601.includeTime(boolean, opcional, por defecto true): True si el formato de salida incluye tiempo "HH:MM", False si no incluye "HH:MM".format("-" | "/", opcional, por defecto "/"): Carácter divisor de fecha, puede ser "DD-MM-YYYY HH:MM" o "DD/MM/YYYY HH:MM".days(number, opcional, por defecto 0): Cantidad de días que serán sumados o restados a los días de la fecha.includeSeconds(boolean, opcional, por defecto false): True si el formato de salida incluye tiempo ":sss", False si no incluye ":sss".
string: Cadena de fecha con formato "DD-MM-YYYY HH:MM:sss" en su forma extendida, "DD-MM-YYYY" en su forma reducida.
const isoDate = "2023-10-16T08:30:00Z";
const formattedDate = formatDate(isoDate);
console.log(formattedDate); // Resultado: "16-10-2023 08:30:00"Dada una fecha en la transforma a formato ISO 8601.
Date(string): Cadena de fecha.
string: Fecha en formato ISO 8601.
const date = "16-10-2023 08:30";
const isoDate = formatDateToIso(date);
console.log(isoDate); // Resultado: "2023-10-16T08:30"Dada una cadena en formato ISO 8601, formatea los datos de tiempo HH:MM con 0 a la izquierda.
isoDate(string, opcional): Cadena de fecha en formato ISO 8601.
string: Cadena de fecha en formato ISO 8601 con HH:MM formateados.
const isoDate = "2023-10-16T08:03:00Z";
const formattedTime = formatTime(isoDate);
console.log(formattedTime); // Resultado: "08:03"Dado un valor cualquiera, analiza y determina su tipo de dato.
valueFrom(string): Cadena de fecha inicial.valueTo(string | null | undefined): Cadena de fecha final.type("min" | "sec" | "hour" | "day"): Tipo de diferencia (resto) que se quiere calcular.includeNegatives(boolean): True si se quiere incluir valores negativos, False caso contrario.
number: Número de diferencia (resto) de fechas según el tipo especificado.
const startDate = "2023-10-15T08:00:00Z";
const endDate = "2023-10-16T08:30:00Z";
const differenceInHours = diffDate(startDate, endDate, "hour", true);
console.log(differenceInHours); // Resultado: 24Dado un valor cualquiera, analiza y determina su tipo de dato.
value(any): Valor.
- "" | "array" | "string" | "number" | "object" | "boolean": Tipo de dato del valor.
const value1 = 42;
const type1 = typeOf(value1);
console.log(type1); // Resultado: "number"
const value2 = "Hola, mundo";
const type2 = typeOf(value2);
console.log(type2); // Resultado: "string"
const value3 = [1, 2, 3];
const type3 = typeOf(value3);
console.log(type3); // Resultado: "array"Si el valor pasado por parametros es de tipo boolean, devuelve ese valor. Caso contrario devolverá el default ( si se existiese ) o false en su defecto.
value(any): El valor que se desea convertir a un booleano.def(boolean | undefined) (Opcional): El valor predeterminado que se retornará sivalueno es un booleano.
boolean: Un valor booleano igual avaluesivaluees un booleano, o el valor predeterminado si se proporciona; de lo contrario,false.
const value1 = true;
const booleanValue1 = toBoolean(value1);
console.log(booleanValue1); // Resultado: true
const value2 = "No es un booleano";
const defaultValue2 = false;
const booleanValue2 = toBoolean(value2, defaultValue2);
console.log(booleanValue2); // Resultado: false (debido al valor predeterminado)
const value3 = null;
const booleanValue3 = toBoolean(value3);
console.log(booleanValue3); // Resultado: false (debido a la conversión predeterminada a false)