titbit-loader - npm Package Compare versions

Comparing version 22.6.0-beta to 22.6.0

bin/new-ctl.js

@@ -64,3 +64,3 @@ #!/usr/bin/env node
 
-  url的查询字符串(?a=1&b=2)参数通过c.query获取，示例：let name = c.query.name
+  url参数(?a=1&b=2)通过 c.query 获取，示例：let name = c.query.name
 
@@ -67,0 +67,0 @@ 使用c.getFile(name)获取上传的文件，示例：let f = c.getFile('image')

package.json

 {
   "name": "titbit-loader",
-  "version": "22.6.0-beta",
+  "version": "22.6.0",
   "description": "loader for titbit framework",
@@ -5,0 +5,0 @@ "main": "loader.js",

README.md

@@ -37,9 +37,59 @@ # titbit-loader
 
-- controller中的文件路径映射为路由。
+- controller中的目录和文件名称映射为路由。
 
 - model目录中的模块初始化后挂载到app.service上，文件名字即为属性名。
 
-- middleware目录中的中间件扩展在controller目录中通过__mid.js或js文件中的__mid函数通过配置的方式进行编排。
+- middleware目录中的中间件扩展在controller目录中通过\_\_mid.js 或 js文件中的 \_\_mid 函数通过配置的方式进行编排。
 
+## 路由规则
 
+默认它按照RESTful规范进行路由的加载过程，比如controller目录中存在admin/account.js文件，那么生成的路由和对应的类方法如下：
+
+```javascript
+
+GET /admin/account/:id 对应于 async get(c) 方法，获取具体的账户信息
+
+GET /admin/account/:id 对应于 async list(c) 方法，获取列表
+
+POST /admin/account 对应于 async post(c) 方法，创建管理员用户
+
+PUT /admin/account/:id 对应于 async put(c) 方法，更新用户信息
+
+DELETE /admin/account/:id 对应于 async delete(c) 方法，删除用户
+
+```
+
+:id参数是account.js类中通过this.param指定的，这部分开发者可以自定义参数。
+
+
+## POST请求的路由参数
+
+默认在处理路由映射时，POST请求表示创建资源，不会带有参数，如果需要传递参数，需要通过在controller类中使用this.postParam属性指定。
+
+```javascript
+
+class api {
+
+  constructor () {
+    this.param = '/:name/:id'
+    //给post请求添加参数路由。
+    this.postParam = '/:name'
+  }
+
+  async get(c) {
+
+  }
+
+  async post (c) {
+
+  }
+
+}
+
+module.exports = api
+
+```
+
+
+
 > 初始化选项中的mname用于指定在app.service哪个子对象上挂载model，在v22.0.0以后，默认直接挂载到app.service上。
@@ -58,3 +108,3 @@
 
-var tbl = new tbloader();
+let tbl = new tbloader();
 
@@ -126,3 +176,3 @@ tbl.init(app);
 
-var app = new titbit({
+let app = new titbit({
   debug: true        
@@ -132,3 +182,3 @@ });
 
-var tbl = new tbloader({
+let tbl = new tbloader({
   //默认就是true，默认通过app.service.model可以获取。
@@ -163,7 +213,7 @@ loadModel: true,
 
-var app = new titbit({
+let app = new titbit({
   debug: true        
 });
 
-var tbl = new tbloader({
+let tbl = new tbloader({
   //默认就是true，默认通过app.service.model可以获取。
@@ -189,7 +239,7 @@ loadModel: true,
 
-var app = new titbit({
+let app = new titbit({
   debug: true
 })
 
-var tbl = new tbloader({
+let tbl = new tbloader({
   //只有GET请求，主页不允许其他请求
@@ -216,7 +266,7 @@ homeFile : 'home.js',
 
-var app = new titbit({
+let app = new titbit({
   debug: true
 });
 
-var tbl = new tbloader({
+let tbl = new tbloader({
   //相对于程序所在目录，相对路径会自动计算转换为绝对路径。
@@ -233,30 +283,2 @@ //如果指定目录下没有对应目录，会自动创建controller、model、middleware
 
-## POST请求的路由参数
-
-默认在处理路由映射时，POST请求表示创建资源，不会带有参数，如果需要传递参数，需要通过在controller类中使用this.postParam属性指定。
-
-```javascript
-
-class api {
-
-  constructor () {
-    this.param = '/:name/:id'
-    //给post请求添加参数路由。
-    this.postParam = '/:name'
-  }
-
-  async get(c) {
-
-  }
-
-  async post (c) {
-
-  }
-
-}
-
-module.exports = api
-
-```
-
 ## 加载中间件
@@ -354,3 +376,3 @@
 
-var tbl = new tbloader({
+let tbl = new tbloader({
   modelPath : 'dbmodel',
@@ -357,0 +379,0 @@ //指定挂载到app.service.dm上，这会创建dm对象并进行挂载。

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

86618

increased by0.79%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

640

increased by3.56%

No dependency changes