prg-class/README.md

Clases genéricas utilizadas por microservicios Programamos SPA.

# Clase Genérica Programamos

Clase para ejecutar procedimientos almacenados mySQL utilizada por librerías Programamos SPA.

## Instalación

Use node package manager para instalar prg-mysql.

```bash
npm install prg-mysql
```

## Uso

```python

# Importa la librería.
import prgMysql = require('prg-mysql');

# Obtiene Token, con los parámetros: Id de Usuario, Id de Sistema, Id de Empresa, Id de Sucursal, dirección IP, User-Agentstring
const ojbMysql = new prgMySql();
const myToken: string = objMysql.StoreProc('pu_store_name', any[1,'2',3], false);
# En el ejemplo anterior, se ejecuta un procedimiento almacenado con los parámetros:
# Nombre Procedimiento: 'pu_store_name'
# Parámetros: Se pasan los parámetros: 1,'2' y 3.
# Mostrar Auditoría: false

# Resultado:
Esta función retorna un objeto:
{
    error: null, // cuando no hay error
    json: value, // valor de retorno
    s: 200 // código http de retorno
}

# Ejemplo de proceso ejecutado con error.
Esta ejecución retorna un error de conexión.
{
    error: 'No se pudo establecer conexión con la base de datos.',
    json: null,
    s: 500 // Error interno del servidor.
}

# Ejemplo de proceso ejecutado con éxito.
Esta ejecución retorna datos.
{
    error: null,
    json: [
            {nombre: 'Carlos', Edad: 21}, 
            {nombre: 'Bernardo', Edad: 83}
            ],
    s: 200 // Ejecución exitosa.
}


https://www.programamos.cl
```

## Licencia

[MIT](https://choosealicense.com/licenses/mit/)