# @corentind/expressive > An express middleware that elegantly handles async controllers and errors management Latest version **1.0.6** (published 2021-01-29) · MIT license · 0 weekly downloads ## Install ```sh npm install @corentind/expressive pnpm add @corentind/expressive yarn add @corentind/expressive bun add @corentind/expressive ``` ## Health **Score 20/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities. Warnings: low downloads; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.6 | | Published | 2021-01-29 | | First published | 2020-08-21 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 1 | | Unpacked size | 31.8 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Corentin Delannoy | | Maintainers | corentind | | Keywords | express, async, controller, error, middleware | ## Links - npm: https://www.npmjs.com/package/@corentind/expressive - Repository: https://github.com/corentind59/expressive - Homepage: https://github.com/corentind59/expressive#readme - Issues: https://github.com/corentind59/expressive/issues - npm.io page: https://npm.io/package/@corentind/expressive ## Dependencies (1) - [@types/express](https://npm.io/package/@types/express.md) ^4.17.7 ## Alternatives - [@sentry/react-native](https://npm.io/package/@sentry/react-native.md) — 2.6M weekly downloads - [@ardatan/aggregate-error](https://npm.io/package/@ardatan/aggregate-error.md) — 708.1K weekly downloads - [custom-error-generator](https://npm.io/package/custom-error-generator.md) — 2.0K weekly downloads - [@technik-sde/prosemirror-recreate-transform](https://npm.io/package/@technik-sde/prosemirror-recreate-transform.md) — 1.5K weekly downloads - [@suchipi/error-utils](https://npm.io/package/@suchipi/error-utils.md) — 78 weekly downloads ## Recent versions - 1.0.6 (latest) — 2021-01-29 - 1.0.5 — 2021-01-29 - 1.0.4 — 2021-01-21 - 1.0.3 — 2020-08-21 - 1.0.2 — 2020-08-21 - 1.0.1 — 2020-08-21 - 1.0.0 — 2020-08-21 ## README [![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![MIT License][license-shield]][license-url]

Expressive

Build structured backend apps with express.js without caring about asynchronous code execution and error management.

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Development
  4. Contributing
  5. License
  6. Contact
## About The Project During development phase of a Node.js + Express project, I'm constantly questioning the file structure of the project and links between different domains of the application. Also, I'm often in trouble when it comes to split responsibilities across many files while trying to keep things simple and stupid. Add to this asynchronous code handling and exception management, and you get the portrait. I needed a robust solution that meets all these requirements while hiding boilerplate code : **Expressive** was born. Expressive is a tiny package, exposing an **Express middleware** and some **helper functions** that ensure that : - *Routers* and *controllers* are two well-defined components of the app, each one having different responsibilities ; - Asynchronous code handling is as simple as making your controller returning a `Promise` ; - Error handling is enhanced with standard HTTP exception catching. ### Built With * [Node.js](https://nodejs.org) * [Yarn](https://yarnpkg.com) * [TypeScript](https://www.typescriptlang.org) ## Getting Started ### Installation Install the package by running : ```shell npm install @corentind/expressive ``` or using Yarn : ````shell yarn add @corentind/expressive ```` ### Basic usage The code snippet below shows a basic example of how to use expressive with express. ```javascript import express from 'express'; import expressive, { handle, Ok, NotFound } from '@corentind/expressive' // Here is your service layer import { getById } from './service'; // Controller doesn't know about req or res objects. async function getTodoById(id) { try { // Asynchronous handling made easy const todo = await getById(id); // Returns a JavaScript literal as a JSON object with 200 status code return new Ok(todo); } catch (e) { // Exception handling can be done exhaustively here. if (e.name === 'NotFoundError') { // Standard error format for simpler API contract throw new NotFound({ code: 'todo-not-found', message: `Todo with ID ${id} could not been found` }); } // Expressive will catch any unhandled error, log it and return a 500 error to the client throw e; } } const app = express(); // `handle` allows expressive to correctly process the asynchronous controller app.get('/todos/:id', handle(({ params: { id } }) => getTodoById(id))); // `expressive` middleware is the brain of the lib app.use(expressive()); app.listen(process.env.PORT || 3000); ``` _For more examples, please refer to the [Documentation (WIP)](https://example.com)_ ## Development ### Installation 1. Clone the repo ```shell git clone https://github.com/corentind59/expressive.git ``` 2. Install NPM packages with Yarn ```shell yarn ``` ### Build ```shell yarn build ``` The project output will be generated in the `dist` folder. ## Contributing Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. 1. Fork the Project 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) 4. Push to the Branch (`git push origin feature/AmazingFeature`) 5. Open a Pull Request ## License Distributed under the MIT License. See `LICENSE` for more information. ## Contact Corentin Delannoy - corentin.delannoy2@gmail.com Project Link: [https://github.com/corentind59/expressive](https://github.com/corentind59/expressive) [contributors-shield]: https://img.shields.io/github/contributors/corentind59/expressive.svg?style=for-the-badge [contributors-url]: https://github.com/corentind59/expressive/graphs/contributors [forks-shield]: https://img.shields.io/github/forks/corentind59/expressive.svg?style=for-the-badge [forks-url]: https://github.com/corentind59/expressive/network/members [stars-shield]: https://img.shields.io/github/stars/corentind59/expressive.svg?style=for-the-badge [stars-url]: https://github.com/corentind59/expressive/stargazers [issues-shield]: https://img.shields.io/github/issues/corentind59/expressive.svg?style=for-the-badge [issues-url]: https://github.com/corentind59/expressive/issues [license-shield]: https://img.shields.io/github/license/corentind59/expressive.svg?style=for-the-badge [license-url]: https://github.com/corentind59/expressive/blob/master/LICENSE --- _Source: https://npm.io/package/@corentind/expressive · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._