@javiertinc/essentials
Version:
Una librería con variedad de funciones útiles que considero esenciales en la mayoría de los desarrollos web.
59 lines (58 loc) • 2.52 kB
TypeScript
import { iConfig, iWatcher } from './_interfaces.js';
export default class strg {
private config;
private obsv;
private cnsl;
constructor(config: iConfig);
/**
* Obtiene el nombre del recurso de almacenamiento basado en el nombre del store.
* @param store - El nombre del store.
* @returns El nombre del recurso de almacenamiento.
*/
private getResourceName;
/**
* Crea un nuevo store en el almacenamiento local.
* Si el store ya existe, se actualizará con los nuevos datos.
* @param store - El nombre del store a crear o actualizar.
* @param data - Los datos a almacenar en el store.
**/
create(store: string, data: any): void;
/**
* Obtiene los datos almacenados en un store específico.
* @param store - El nombre del store del cual se desean obtener los datos.
* @returns Los datos almacenados en el store, o null si no existe.
**/
get(store: string): any;
/**
* Actualiza los datos de un store específico.
* Si el store no existe, se creará uno nuevo con los datos proporcionados.
* @param store - El nombre del store a actualizar.
* @param data - Los nuevos datos a almacenar en el store.
**/
update(store: string, data: any): void;
/**
* Elimina un store específico del almacenamiento local.
* @param store - El nombre del store a eliminar.
**/
delete(store: string): void;
/**
* Crea un observador para un store específico.
* El observador se activará cuando se detecte una actualización en el store.
* @param store - El nombre del store a observar.
* @param from - Desde dónde se está creando el observador (puede ser un nombre de componente, función, etc.).
* @returns Un objeto Watcher que permite suscribirse a actualizaciones reactivas del store.
**/
watch(store: string, from: string): iWatcher;
/**
* Elimina un observador de un store específico.
* @param store - El nombre del store del cual se desea eliminar el observador.
* @param from - Desde dónde se está eliminando el observador (puede ser un nombre de componente, función, etc.).
**/
unwatch(store: string, from: string): void;
/**
* Gatilla el evento de actualización del store.
* Este método se utiliza para notificar a los observadores que el store ha sido actualizado.
* @param store - El nombre del store que ha sido actualizado.
**/
trigger(store: string): void;
}