Monkfish

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

Getting Started

npm install --save @cork-labs/moknfish

API

Application

new Application(eventHandler, errorHandler, logger)

newEvent(data)

newContext(type, data)

handle(event, context, logger)

ErrorHandler

constructor(fns, config)

handle(err, event, context, logger)

EventHandler

constructor(controllers, preFns, postFns)

handle(event, context, logger)

constructor(fns, config)

Context

constructor(data)

Event

constructor(type, data)

Result

constructor(data, meta)

ApplicationError extends Error

constructor (name, severity, details, parent)

Develop

# 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 before submitting issues and PRs.

Links

• npm-bump
• chai
• chai-as-promised
• sinon
• sinon-chai

MIT License

Copyright (c) 2018 Cork Labs