vitis-engine-lib/README.md

Lib used on Vitis engines

# Vitis Engine Lib

## Properties

```javascript
import propertiesSrvc from "vitis-engine-lib";
```

### propertiesSrvc.getProperties(): Promise<any>

Récupère les properties de `conf/properties.json`

```javascript
propertiesSrvc.getProperties().then(oProperties => {
  console.log('oProperties', oProperties); 
});
```

## Logger

```javascript
import Logger from "vitis-engine-lib";

const oLogger = new Logger(oProperties);
```

### logger.disableConsoleMessage()

Désactive le log en console lors de l'écriture dans le fichier (par défaut le log en console est actif).

### logger.enableConsoleMessage()

Active le log en console lors de l'écriture dans le fichier (par défaut le log en console est actif).

### logger.log(message: any, variable?: any, level: string = 'INFO')

Écrit un message dans le logs

```javascript
oLogger.log('Hello world');
```

## DB

```javascript
import Db from "vitis-engine-lib";

const oDb = new Db(oProperties, {
    user: properties.db_superuser,
    host: properties.db_server,
    database: properties.db_name,
    password: properties.db_password,
    port: properties.db_port,
  }, oLogger);
```

### db.connect()
Connexion à la base

### db.disconnect()
Déconnexion de la base

### db.query(sQuery: string, aParams: any[] = [], bAutoConnect = true)
Lance une requette

### db.setMaxConnectionTime()
fixe la durée maximale d'une requête

### db.disableTimeOut()
Désactive la déconnexion automatique

## Local FS

```javascript
import LocalFS from "vitis-engine-lib";
```

### zipDir(dirPath: string, zipName: string|null = null): Promise<any>
Compresse un dossier

### deleteFolder(folderPath: string)
Supprime une dossier et son contenu


### changeFolderRights(folderPath: string, sRights: string)
Donne tous les droits au dossier


### changeFolderOwner(folderPath: string, sOwner: string)
Donne tous les droits au dossier