Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qiwi/inno_ts
TypeScript + koa wrapper
https://github.com/qiwi/inno_ts
Last synced: 4 days ago
JSON representation
TypeScript + koa wrapper
- Host: GitHub
- URL: https://github.com/qiwi/inno_ts
- Owner: qiwi
- Created: 2017-01-16T11:02:38.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-22T07:46:54.000Z (almost 2 years ago)
- Last Synced: 2024-11-02T10:08:29.904Z (13 days ago)
- Language: TypeScript
- Size: 395 KB
- Stars: 4
- Watchers: 8
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
innots is a wrapper around [koa framework](https://www.npmjs.com/package/koa)
and some popular koa middlewares for quick app init and bootstrap.
[](https://travis-ci.org/qiwi/inno_ts)
# Overview
First of all module is designed to use with typescript and it's async await implementation
but you can also use it with plain javascript.
```ts
import {InnotsApp, Context} from 'innots';
const app = new InnotsApp({
port: 9080
});
app.route('post', '/test', async (ctx: Context, next: () => any): Promise => {
ctx.body = 1;
await next();
});
app.bootstrap().then(() => {
console.log('Server started');
});
```
You can also define validation middleware in route method
(validation is powered by [joi library](https://www.npmjs.com/package/joi)):
```ts
app.route(
'get',
'/foo,
((joi) => {
return joi.object().keys({
testField: joi.string().trim().email().required(),
testQueryField: joi.number().integer()
});
}),
async (ctx: Context, next: () => any): Promise => {
// you can access your data by ctx.validatedData (.camelCase or .originalCase) parameter
await next();
})
);
```
# Usage
## InnotsApp class
### new InnotsApp(config: IAppConfig, router?: Router, customMiddlewares?: IAppMiddlewares)
Constructs new http server (powered by [koa framework](https://www.npmjs.com/package/koa)) with pre-defined built in router and middlewares.
#### config: IAppConfig
An object for configuring built in middlewares.
```ts
{
host?: string; // listening host, e.g. 'localhost'
port: number; // listening port
jwt?: { // config for jwt middleware (jwt middleware is enabled if config exists)
secret: string; // jwt secret
publicPath: string; // regexp for public paths (not protected by jwt)
prefix?: string; // prefix before token in auth header (e.g JWT in "JWT ", or "Bearer" in "Bearer ")
};
cors?: { // CORS is enabled by default, you can edit it by providing this config param
enabled: boolean; // enable/disable CORS
origin: string; // Access-Control-Allow-Origin header
credentials: string; // Access-Control-Allow-Credentials header
};
userAgent?: boolean; // Enable or disable userAgent processing middleware
enableLogMiddleware?: boolean; // Enable or disable request info logging middleware
}
```
#### router?: Router
An instance of [koa-router](https://www.npmjs.com/package/koa-router) (you can use it if you don't want to use built in router)
#### customMiddlewares: IAppMiddlewares
An object with your own custom implementations if middlewares (if you don't want to use
built in middlewares):
```ts
{
bodyParser?: Middleware; // bodyParser middleware - defaults to koa-bodyparser
log?: Middleware;
error?: Middleware;
jwt?: Middleware;
cors?: Middleware;
userAgent?: Middleware;
success?: Middleware;
}
```
### app.route(method: string, url: string, joiSchemaGenerator: TJoiSchemaGenerator, ...actions: IMiddleware[]): void
### app.route(method: string, url: string, ...actions: IMiddleware[]): void
Defines middleware for processing request.
```ts
app.route(
'get',
'/foo,
async (ctx: Context, next: () => any): Promise => {
ctx.body = true
await next();
})
);
```
You can also make validation middleware here:
```ts
app.route(
'get',
'/foo,
((joi) => {
return joi.object().keys({
testField: joi.string().trim().email().required(),
testQueryField: joi.number().integer()
});
}),
async (ctx: Context, next: () => any): Promise => {
// you can access your data by ctx.validatedData parameter
await next();
})
);
```
### app.bootstrap(): Promise
Starts your app with defined routes and middlewares.