# mini-tools algunas herramientas para express [![npm-version](https://img.shields.io/npm/v/mini-tools.svg)](https://npmjs.org/package/mini-tools) [![downloads](https://img.shields.io/npm/dm/mini-tools.svg)](https://npmjs.org/package/mini-tools) [![linux](https://github.com/codenautas/mini-tools/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/codenautas/mini-tools/actions/workflows/build-and-test.yml) [![windows](https://ci.appveyor.com/api/projects/status/github/codenautas/mini-tools?svg=true)](https://ci.appveyor.com/project/codenautas/mini-tools) [![coverage](https://img.shields.io/coveralls/codenautas/mini-tools/master.svg)](https://coveralls.io/r/codenautas/mini-tools) [![sonar](https://sonarcloud.io/api/project_badges/measure?project=codenautas_mini-tools&metric=alert_status)](https://sonarcloud.io/summary/overall?id=codenautas_mini-tools) [![qa-control](https://github.com/codenautas/mini-tools/actions/workflows/qa-control.yml/badge.svg)](https://github.com/codenautas/mini-tools/actions/workflows/qa-control.yml) idioma: ![castellano](https://raw.githubusercontent.com/codenautas/multilang/master/img/lang-es.png) también disponible en: [![Inglés](https://raw.githubusercontent.com/codenautas/multilang/master/img/lang-en.png)](README.md) ## Instalación ```sh $ npm install mini-tools ``` ## Objetivo principal Tener a mano algunas herramientas pequeñas para express ## API ### serveErr(req, res [, next]) Retorna una función que envía un mensaje de error al cliente. Si el objeto error tiene especificada la propiedad: * code: es mostrada antes del mensaje. * status: es enviado como status (si no se envía 400) ```js app.post('/insert' , function(req,res){ //... if(duplicate){ serveErr(req,res)(new Error("Duplicate name. Can't insert")); return; } //... ``` Está diseñado para utilizarse con promesas ```js app.use('/tools', function(req,res,next){ //... .then(function(){ if(not_in_this_middleware){ throw new Error("next"); } // ... }).catch(serveErr(req,res,next)); ``` *catch* espera un función que recibe un error. *serveErr* devuelve esa función. Cuando err es Error("next") *serveErr* llama a next y no envía ningún mensaje al cliente (porque entiende que no es un error sino que debe capturarse en el siguiente middleware); de otro modo envía un error 400 con el mensaje de error (parámetro de Error). ### serveJade(path, opts) ```js var express = require('express'); var app = express(); app.use('/',MiniTools.serveJade('./static',true)); app.use('/main',MiniTools.serveJade('./static/index.jade',false)); ``` Retorna un middleware compatible con express que envía y compila archivos jade/pug (con extensión *.jade*). #### opciones Si el parámetro *opts* es un booleano se asume que es el valor de la opción *any*. Si `any==true` acepta cualquier nombre (sin extensión) y busca si existe el archivo *.jade* correspondiente; si no existe tal archivo llama a `next()` para que continúe con el siguiente middleware. Si `any==false` lo que se especifica es un archivo específico. Otras opciones especificadas en *opts* son pasadas a la función `pug.render` **Nota**: hay que agregar el módulo `"pug"` a `package.json` ### serveStylus(path, any) ```js var express = require('express'); var app = express(); app.use('/',MiniTools.serveStylus('./static',true)); app.use('/site.css',MiniTools.serveStylus('./static/index.styl',false)); ``` Retorna un middleware compatible con express que envía y compila archivos jade. Si `any==true` acepta cualquier nombre (sin extensión) y busca si existe el archivo .jade correspondiente; si no existe tal archivo llama a `next()` para que continúe con el siguiente middleware. Si `any==false` lo que se especifica es un archivo específico. **Nota**: hay que agregar `"stylus"` a `package.json` ### serveText(anyText,contentTypeText) ```js var express = require('express'); var app = express(); app.use('/about',MiniTools.serveText('

This app

','html')); app.use('/is-up-service',MiniTools.serveText('Yes.')); ``` Retorna un middleware compatible con express que envía un archivo de texto plano. Opcionalmente se le puede indicar el "content type" (si no se le pasa una "/" se entiende que es text) ### serveJson(object) ```js var express = require('express'); var app = express(); var config = {devel:false, title: "title"}; app.use('/config',MiniTools.serveJson(config)); ``` Retorna un middleware compatible con express que envía un objeto en formato JSON ### serveYaml(object) ```js var express = require('express'); var app = express(); var config = {devel:false, title: "title"}; app.use('/config',MiniTools.serveYaml(config)); ``` Retorna un middleware compatible con express que envía un objeto en formato yaml (usando [js-yaml](https:www.npmjs.com/package/js-yaml)). ### readConfig(list, opts) ```js MiniTools.readConfig( [ {production: true}, 'package.json', 'other-configs.yml', 'more-configs', ], {whenNotExist:'ignore'} ).then(function(config){ console.log(config); }); ``` Lee la configuración de la lista empezando por el primer archivo y agregando la configuración de los siguientes archivos (usando [best-globals.changing](https://www.npmjs.com/package/best-globals#changingoriginalconfig-changes-options)). Si el elemento de la lista es un nombre de archivo terminado en .json .yaml o .yml se lee y se parsea, si no tiene extensión se busca uno con alguna de esas extensiones, si es un objeto plano se usa directamente. **opciones** * whenNotExist:'ignore' * whenNotExist:'fail' ## Licencia [MIT](LICENSE)