koify v1.0.4

Koify

Complete ecosystem that assists you to setup feature-rich service with utilities like logging and database connector that embedded in the package. Based on Koa.js.

Table of Contents

• How to Quickly setup a Server
• Utilities
  • KoifyEnv
  • KoifyDatabase

How to Quickly setup a Server

import Koa from 'koa';
import Router from '@koa/router';

import { KoifyRouter, Get, KoifyService } from 'koify';

const app = new Koa();

const getUsersRequest = new KoifyRequest([{
  name: 'username',
  from: 'params',
  type: 'string',
  require: true,
}, {
  name: 'age',
  from: 'query',
  type: 'number',
  validator: () => true,
  require: true,
}, {
  name: 'location',
  from: 'body',
  type: 'string',
  require: false,
}, {
  name: 'accounts',
  from: 'body',
  type: 'array',
  require: false,
}, {
  name: 'detail',
  from: 'body',
  type: 'object',
  require: false,
}, {
  name: 'isLast',
  from: 'body',
  type: 'boolean',
  require: false,
}]);

class TestService extends KoifyService {
  public test(ctx: any) {
    const { username } : { username: string } = getUsersRequest.getParams(ctx);
    const { age } : { age: number } = getUsersRequest.getQuery(ctx);
    const {
      location, accounts, detail, isLast,
    } : {
      location: string,
      accounts: any[],
      detail: any,
      isLast: boolean,
    } = getUsersRequest.getBody(ctx);

    return this.success({
      ctx,
      body: { username, age, location, accounts, detail, isLast },
    });
  }
};

const router = KoifyRouter(
  new Router(),
  new TestService(),
  Post('/:username', 'test'),
);

app.use(router.routes());

app.listen(3000);

console.log('Server listening on PORT 3000');

Utilities

KoifyEnv

Automatically import all environment variables from .env file, combine it with default set of env variables provided by users (optional) and check if all required variables are defined (optional).

interface ApplicationEnv {
  MYSQL_HOST: string,
  MYSQL_USER: string,
  MYSQL_PASSWORD: string,
  MYSQL_DATABASE: string,
}

const envs = <ApplicationEnv>KoifyEnv(undefined, [
  'MYSQL_HOST',
  'MYSQL_USER',
  'MYSQL_PASSWORD',
  'MYSQL_DATABASE',
]);

console.log(envs.MYSQL_HOST);

KoifyDatabase

Using Knex as the foundation, we create a global storage to store all database connection through KoifyDatabase. Support for different database types like MySQL, SQLite and PostgreSQL are coming soon. Support for ORM are coming soon as well.

const mysqlDbConfig = {
  client: 'mysql',
  connection: {
    host: envs.MYSQL_HOST,
    user: envs.MYSQL_USER,
    password: envs.MYSQL_PASSWORD,
    database: envs.MYSQL_DATABASE,
  }
};

KoifyDatabase.addConnection(mysqlDbConfig, 'mysql');

const db = new KoifyMySQLDatabase('user', 'mysql');
const result = await db.findAll();