docs: add necessary action api
This commit is contained in:
		
							parent
							
								
									678b6cef21
								
							
						
					
					
						commit
						32348d1363
					
				@ -48,21 +48,7 @@ Action 是对资源的操作过程的描述,通常包含数据库处理等,
 | 
			
		||||
 | 
			
		||||
参数的合并过程提供了针对操作处理的可扩展性,可以通过自定义中间件的方式按业务需求进行参数的前置解析和处理,例如表单提交的参数验证就可以在此环节实现。
 | 
			
		||||
 | 
			
		||||
预设的参数与默认合并策略如下表:
 | 
			
		||||
 | 
			
		||||
| 参数名 | 类型 | 默认值 | 合并策略 | 描述 |
 | 
			
		||||
| --- | --- | --- | --- | --- |
 | 
			
		||||
| `filterByTk` | `number \| string` | - | SQL `and` | 查询主键值 |
 | 
			
		||||
| `filter` | `FilterOptions` | - | SQL `and` | 查询过滤参数 |
 | 
			
		||||
| `fields` | `string[]` | - | 取并集 | 字段组 |
 | 
			
		||||
| `appends` | `string[]` | `[]` | 取并集 | 附加的关联字段组 |
 | 
			
		||||
| `except` | `string[]` | `[]` | 取并集 | 排除的字段组 |
 | 
			
		||||
| `whitelist` | `string[]` | `[]` | 取交集 | 可处理字段的白名单 |
 | 
			
		||||
| `blacklist` | `string[]` | `[]` | 取交集 | 可处理字段的黑名单 |
 | 
			
		||||
| `sort` | `string[]` | - | SQL `order by` | 查询排序参数 |
 | 
			
		||||
| `page` | `number` | - | 覆盖 | 页码 |
 | 
			
		||||
| `pageSize` | `number` | - | 覆盖 | 每页数量 |
 | 
			
		||||
| `values` | `Object` | - | shallow merge | 操作提交的数据 |
 | 
			
		||||
预设的参数可以参考 [/api/actions] 中不同操作的参数。
 | 
			
		||||
 | 
			
		||||
参数中还包含请求资源路由的描述部分,具体如下:
 | 
			
		||||
 | 
			
		||||
@ -90,7 +76,7 @@ app.resourcer.define('books', {
 | 
			
		||||
  },
 | 
			
		||||
  middlewares: [
 | 
			
		||||
    async (ctx, next) => {
 | 
			
		||||
      ctx.action.mergeParam({
 | 
			
		||||
      ctx.action.mergeParams({
 | 
			
		||||
        values: {
 | 
			
		||||
          id: Math.random().toString(36).substr(2, 10),
 | 
			
		||||
          publishedAt: new Date(),
 | 
			
		||||
@ -101,3 +87,62 @@ app.resourcer.define('books', {
 | 
			
		||||
  ]
 | 
			
		||||
});
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
## 实例方法
 | 
			
		||||
 | 
			
		||||
### `mergeParams()`
 | 
			
		||||
 | 
			
		||||
将额外的参数合并至当前参数集,且可以根据不同的策略进行合并。
 | 
			
		||||
 | 
			
		||||
**签名**
 | 
			
		||||
 | 
			
		||||
* `mergeParams(params: ActionParams, strategies: MergeStrategies = {})`
 | 
			
		||||
 | 
			
		||||
**参数**
 | 
			
		||||
 | 
			
		||||
| 参数名 | 类型 | 默认值 | 描述 |
 | 
			
		||||
| --- | --- | --- | --- |
 | 
			
		||||
| `params` | `ActionParams` | - | 额外的参数集 |
 | 
			
		||||
| `strategies` | `MergeStrategies` | - | 针对每个参数的合并策略 |
 | 
			
		||||
 | 
			
		||||
内置操作的默认合并策略如下表:
 | 
			
		||||
 | 
			
		||||
| 参数名 | 类型 | 默认值 | 合并策略 | 描述 |
 | 
			
		||||
| --- | --- | --- | --- | --- |
 | 
			
		||||
| `filterByTk` | `number \| string` | - | SQL `and` | 查询主键值 |
 | 
			
		||||
| `filter` | `FilterOptions` | - | SQL `and` | 查询过滤参数 |
 | 
			
		||||
| `fields` | `string[]` | - | 取并集 | 字段组 |
 | 
			
		||||
| `appends` | `string[]` | `[]` | 取并集 | 附加的关联字段组 |
 | 
			
		||||
| `except` | `string[]` | `[]` | 取并集 | 排除的字段组 |
 | 
			
		||||
| `whitelist` | `string[]` | `[]` | 取交集 | 可处理字段的白名单 |
 | 
			
		||||
| `blacklist` | `string[]` | `[]` | 取并集 | 可处理字段的黑名单 |
 | 
			
		||||
| `sort` | `string[]` | - | SQL `order by` | 查询排序参数 |
 | 
			
		||||
| `page` | `number` | - | 覆盖 | 页码 |
 | 
			
		||||
| `pageSize` | `number` | - | 覆盖 | 每页数量 |
 | 
			
		||||
| `values` | `Object` | - | 深度合并 | 操作提交的数据 |
 | 
			
		||||
 | 
			
		||||
**示例**
 | 
			
		||||
 | 
			
		||||
```ts
 | 
			
		||||
ctx.action.mergeParams({
 | 
			
		||||
  filter: {
 | 
			
		||||
    name: 'foo',
 | 
			
		||||
  },
 | 
			
		||||
  fields: ['id', 'name'],
 | 
			
		||||
  except: ['name'],
 | 
			
		||||
  sort: ['id'],
 | 
			
		||||
  page: 1,
 | 
			
		||||
  pageSize: 10,
 | 
			
		||||
  values: {
 | 
			
		||||
    name: 'foo',
 | 
			
		||||
  },
 | 
			
		||||
}, {
 | 
			
		||||
  filter: 'and',
 | 
			
		||||
  fields: 'union',
 | 
			
		||||
  except: 'union',
 | 
			
		||||
  sort: 'overwrite',
 | 
			
		||||
  page: 'overwrite',
 | 
			
		||||
  pageSize: 'overwrite',
 | 
			
		||||
  values: 'deepMerge',
 | 
			
		||||
});
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
		Loading…
	
		Reference in New Issue
	
	Block a user