https://github.com/eggjs/egg-parameters
Merge all parameters (ctx.params, ctx.request.query, ctx.request.body) into ctx.params like Rails application.
https://github.com/eggjs/egg-parameters
egg egg-plugin eggjs parameters
Last synced: about 2 months ago
JSON representation
Merge all parameters (ctx.params, ctx.request.query, ctx.request.body) into ctx.params like Rails application.
- Host: GitHub
- URL: https://github.com/eggjs/egg-parameters
- Owner: eggjs
- License: mit
- Created: 2018-05-29T06:22:38.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-01-06T07:32:54.000Z (about 6 years ago)
- Last Synced: 2025-11-09T06:19:36.555Z (4 months ago)
- Topics: egg, egg-plugin, eggjs, parameters
- Language: JavaScript
- Homepage:
- Size: 79.1 KB
- Stars: 26
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
- License: LICENSE
Awesome Lists containing this project
README
egg-parameters
--------------
[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]
[npm-image]: https://img.shields.io/npm/v/egg-parameters.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-parameters
[travis-image]: https://img.shields.io/travis/eggjs/egg-parameters.svg?style=flat-square
[travis-url]: https://travis-ci.org/eggjs/egg-parameters
[codecov-image]: https://codecov.io/github/eggjs/egg-parameters/coverage.svg?branch=master
[codecov-url]: https://codecov.io/github/eggjs/egg-parameters?branch=master
[david-image]: https://img.shields.io/david/eggjs/egg-parameters.svg?style=flat-square
[david-url]: https://david-dm.org/eggjs/egg-parameters
[snyk-image]: https://snyk.io/test/npm/egg-parameters/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg-parameters
[download-image]: https://img.shields.io/npm/dm/egg-parameters.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-parameters
Merge all parameters (`ctx.params`, `ctx.request.query`, `ctx.request.body`) into `ctx.params` like Rails application.
## Configuration
`config/plugin.js`
```js
exports.parameters = {
enable: true,
package: 'egg-parameters',
};
```
`config/config.default.js`
```js
exports.parameters = {
logParameters: true,
// param names that you want filter in log.
filterParameters: ['password'],
};
```
## Usage
When you add `egg-parameters` into your `package.json` this will enabled by default.
```js
// app/controller/posts.js
module.exports = class {
/**
* POST /posts?title=jason&foo=1&user_id=123
*/
async create() {
const { ctx } = this;
const postParam = ctx.params.permit('title', 'body')
// postParam => { title: '', body: '' }
// postParam.isPermitted() => true
// :foo, :user_id will be filted
// Now you can use safely for egg-sequelize create param
const post = await ctx.model.Post.create(postParam);
ctx.body = post;
}
};
```