https://github.com/eggjs/jsonp
jsonp support for egg, with security check inside
https://github.com/eggjs/jsonp
egg-plugin jsonp
Last synced: 5 months ago
JSON representation
jsonp support for egg, with security check inside
- Host: GitHub
- URL: https://github.com/eggjs/jsonp
- Owner: eggjs
- License: mit
- Created: 2017-01-22T08:04:08.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2025-01-11T10:42:49.000Z (about 1 year ago)
- Last Synced: 2025-09-29T01:07:44.695Z (5 months ago)
- Topics: egg-plugin, jsonp
- Language: TypeScript
- Homepage:
- Size: 35.2 KB
- Stars: 17
- Watchers: 9
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-egg - egg-jsonp - jsonp 支持。   (仓库 / [内置插件](https://eggjs.org/zh-cn/basics/plugin.html#%E6%8F%92%E4%BB%B6%E5%88%97%E8%A1%A8))
README
# @eggjs/jsonp
[![NPM version][npm-image]][npm-url]
[](https://github.com/eggjs/jsonp/actions/workflows/nodejs.yml)
[![Test coverage][codecov-image]][codecov-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]
[](https://nodejs.org/en/download/)
[](https://makeapullrequest.com)
[npm-image]: https://img.shields.io/npm/v/@eggjs/jsonp.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@eggjs/jsonp
[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/jsonp.svg?style=flat-square
[codecov-url]: https://codecov.io/github/eggjs/jsonp?branch=master
[snyk-image]: https://snyk.io/test/npm/@eggjs/jsonp/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/@eggjs/jsonp
[download-image]: https://img.shields.io/npm/dm/@eggjs/jsonp.svg?style=flat-square
[download-url]: https://npmjs.org/package/@eggjs/jsonp
An egg plugin for jsonp support.
## Requirements
- egg >= 4.x
## Install
```bash
npm i @eggjs/jsonp
```
## Usage
```ts
// {app_root}/config/plugin.ts
export default {
jsonp: {
enable: true,
package: '@eggjs/jsonp',
},
};
```
## Configuration
- {String|Array} callback - jsonp callback method key, default to `[ '_callback', 'callback' ]`
- {Number} limit - callback method name's max length, default to `50`
- {Boolean} csrf - enable csrf check or not. default to false
- {String|RegExp|Array} whiteList - referrer white list
if whiteList's type is `RegExp`, referrer must match `whiteList`, pay attention to the first `^` and last `/`.
```ts
export default {
jsonp: {
whiteList: /^https?:\/\/test.com\//,
},
};
// matchs referrer:
// https://test.com/hello
// http://test.com/
```
if whiteList's type is `String` and starts with `.`:
```ts
export default {
jsonp: {
whiteList: '.test.com',
},
};
// matchs domain test.com:
// https://test.com/hello
// http://test.com/
// matchs subdomain
// https://sub.test.com/hello
// http://sub.sub.test.com/
```
if whiteList's type is `String` and not starts with `.`:
```ts
export default {
jsonp: {
whiteList: 'sub.test.com',
},
};
// only matchs domain sub.test.com:
// https://sub.test.com/hello
// http://sub.test.com/
```
whiteList also can be an array:
```ts
export default {
jsonp: {
whiteList: [ '.foo.com', '.bar.com' ],
},
};
```
see [config/config.default.ts](https://github.com/eggjs/jsonp/blob/master/src/config/config.default.ts) for more detail.
## API
- ctx.acceptJSONP - detect if response should be jsonp, readonly
## Example
In `app/router.ts`
```ts
// Create once and use in any router you want to support jsonp.
const jsonp = app.jsonp();
app.get('/default', jsonp, 'jsonp.index');
app.get('/another', jsonp, 'jsonp.another');
// Customize by create another jsonp middleware with specific configurations.
app.get('/customize', app.jsonp({ callback: 'fn' }), 'jsonp.customize');
```
## Questions & Suggestions
Please open an issue [here](https://github.com/eggjs/egg/issues).
## License
[MIT](LICENSE)
## Contributors
[](https://github.com/eggjs/jsonp/graphs/contributors)
Made with [contributors-img](https://contrib.rocks).