mcf-objects/README.md

31 lines
1.2 KiB
Markdown
Raw Normal View History

2021-06-21 15:44:37 +01:00
# MCF-Objects
2020-03-16 23:25:54 +01:00
2021-06-21 15:44:37 +01:00
Se trata de una librería para la gestión de objetos que añade tipos estáticos y objetos basados en clases.
2020-03-16 23:25:54 +01:00
2021-06-21 15:44:37 +01:00
Admite los siguientes tipos básicos:
- String
- Number
- Boolean
- Array
- Enum
2020-03-16 23:25:54 +01:00
2021-06-21 15:44:37 +01:00
Mediante la definición de los objetos estáticos se pueden establecer límites a los valores, listas de valores permitidos...
2020-03-16 23:25:54 +01:00
2021-06-21 15:44:37 +01:00
## Entorno de desarrollo
La bibioteca se transpila usando `babel` y se compila con `webpack`.
El entorno de desarrollo se levanta ejecutando `npm run start` y se puede acceder a él en http://localhost:9000 para ver el funcionamiento durante el desarrollo.
## Despliegue
Para el despliege a producción, debe subirse el proyecto a un repositorio `git`. Para poder trabajar con diferentes versiones de la biblioteca se emplean tags de git, por lo que una vez que se considera terminada una nueva versión de la misma sería necesario generar un nuevo tag de git con el número de la versión:
```sh
v0.1.3
```
## Arquitectura
El código de la aplicación se encuentra condensado en el archivo `index.js`, el cual exporta la clase definedObject.
El constructor de clase lee la definición pasada como argumento cuando crea una instancia de clase y efectúa las verificaciones necesarias antes de devolver dicha instancia.