# @cork-labs/monkfish

> Node.js application framework inspired by DDD, Hexagonal and Clean principles

Latest version **0.4.0** (published 2019-01-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install @cork-labs/monkfish
pnpm add @cork-labs/monkfish
yarn add @cork-labs/monkfish
bun add @cork-labs/monkfish
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.0 |
| Published | 2019-01-11 |
| First published | 2018-03-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 61.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Andre Torgal |
| Maintainers | andrezero |

## Links

- npm: https://www.npmjs.com/package/@cork-labs/monkfish
- Repository: https://github.com/cork-labs/monkfish
- Issues: https://github.com/cork-labs/monkfish/issues
- npm.io page: https://npm.io/package/@cork-labs/monkfish

## Dependencies (4)

- [cors](https://npm.io/package/cors.md) ^2.8.4
- [express](https://npm.io/package/express.md) ^4.16.2
- [body-parser](https://npm.io/package/body-parser.md) ^1.18.2
- [cookie-parser](https://npm.io/package/cookie-parser.md) ^1.4.3

## Recent versions

- 0.4.0 (latest) — 2019-01-11
- 0.3.0 — 2019-01-10
- 0.2.2 — 2019-01-05
- 0.2.1 — 2018-03-19
- 0.2.0 — 2018-03-15
- 0.1.0 — 2018-03-14
- 0.0.2 — 2018-03-05

## README

# Monkfish

> Node.js application framework inspired by DDD, Hexagonal and Clean principles.


## Getting Started

```shell
npm install --save @cork-labs/moknfish
```



## API


### class Application

#### constructor(eventHandler, errorHandler, logger)

#### newEvent(data)

#### newContext(type, data)

#### handle(event, context, logger)


### class ErrorHandler

#### constructor(fns, config)

#### handle(err, event, context, logger)


### class EventHandler

#### constructor(controllers, preFns, postFns)

#### handle(event, context, logger)

#### constructor(fns, config)


### class Context

#### constructor(data)


### class Event

#### constructor(type, data)


### class Result

#### constructor(data, meta)


### class ApplicationError extends Error

#### constructor (name, severity, details, parent)


## Develop

```shell
# lint and fix
npm run lint

# run test suite
npm test

# lint and test
npm run build

# serve test coverage
npm run coverage

# publish a minor version
node_modules/.bin/npm-bump minor
```


### Contributing

We'd love for you to contribute to our source code and to make it even better than it is today!

Check [CONTRIBUTING](https://github.com/cork-labs/contributing/blob/master/CONTRIBUTING.md) before submitting issues and PRs.


## Links

- [npm-bump](https://www.npmjs.com/package/npm-bump)
- [chai](http://chaijs.com/api/)
- [chai-as-promised](http://chaijs.com/plugins/chai-as-promised/)
- [sinon](http://sinonjs.org/)
- [sinon-chai](https://github.com/domenic/sinon-chai)


## [MIT License](LICENSE)

[Copyright (c) 2018 Cork Labs](http://cork-labs.mit-license.org/2018)

---
_Source: https://npm.io/package/@cork-labs/monkfish · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._