@typedefs/goa v0.1.5

@goa/koa

This is the source code for the @goa/koa repository that actually compiles this source code. Please navigate there for the documentation.

@goa/koa is the Koa web-sever compiled and optimised with Google Closure Compiler so that it has only 1 dependency (mime-db, for easy access to upgrades). The types are written as JSDoc and don't require installing typings. The aim of this project is to demonstrate how to modernise the old-school NPM package making, including starting to use import/export statements without Babel, restoring to pure JSDoc without TypeScript, and compiling the code into the single executable using the compiler, and testing the code with Zoroaster testing framework which is twice as fast and weighs 500KB against 50MB compared with Jest (as used in the original repository).

yarn add @goa/koa

Table Of Contents

• Table Of Contents
• Goa
• Types
• Packages
• Tests
• Copyright

Goa

Goa is the same application, as Koa. It has the same interface for the app object, as well as context, request and response API.

import Goa from '@goa/goa'

const app = new Goa()
app.use((ctx) => {
  ctx.body = 'hello world'
})

hello world

Types

The types detailed information can be found here. This is a detailed breakdown of type annotations that was used for compilation, therefore it's rather raw because it's meant for generates externs and typedefs for JSDoc. The Koa documentation can be found on its page.

Packages

The Koa dependencies as packages had to be rewritten in ES6. Some of them were created as separate packages, and some were included in the source code (repository) in the modules directory.

The external modules were created with tests also written to ensure their source and compiled versions work as expected.

Tests

The tests were updated for context testing and include all original Koa tests.

✅ View 326 tests

Copyright

The Koa web server by its authors.