Skip to content

maskletter/kvl-document

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 

Repository files navigation

Kvl(一个基于express/ts的Nodejs框架)



基于 express ,兼容 express 所有方法及中间件,两者可并行使用,使用 typescript 实现,内置pm2基础服务调用,统一的全局接口错误处理回调。

npm version npm version

👉👉👉演示项目链接




框架进度

功能 状态 说明
express 已完成 以express为基础
typescript 已完成 完整的ts配置,实现开发环境监听代码自动重启服务
router 已完成 模块化路由功能
interceptor 已完成 拦截器
validation 待完善 数据验证器
Api interface 未开始 创建api文档
pm2 已完成 利用pm2官方api,实现简单的pm2服务
throw 已完成 接口异常处理
cli 已完成,待优化 基于node的cmd命令行工具
环境配置 已完成 自定义环境变量

通过Npm 方式安装kvl,并创建服务运行

$ npm install kvl@latest -g
$ kvl init hellworld
$ cd hellworld
$ kvl dev

基础方式使用

import kvl from 'kvl';
import { Main ,Router, config, ValidationDone } from 'kvl';
@Router({}) 
class HelloWord{

	private msg: string = 'Hello, world'

	@config({ url: '/hello', name: 'hello', type: 'get' })
	private hello(req: Kvl.Request, res: Kvl.Response): void {
		res.end(`<h1>${this.msg}</h1>`)
	}

}
Main({
	port: 8080,
	router: [ HelloWord ],
})

Releases

No releases published

Packages

No packages published