egg-jsonp
An egg plugin for jsonp support.
Install
$ npm i egg-jsonp --save
Usage
// {app_root}/config/plugin.jsexportsjsonp = enable: true package: 'egg-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 /
.
exportsjsonp = whiteList: /^https?:\/\/test.com\//// matchs referrer:// https://test.com/hello// http://test.com/
if whiteList's type is String
and starts with .
:
exportsjsonp = 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 .
:
exportsjsonp = 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:
exportsjsonp = whiteList: '.foo.com' '.bar.com' ;
see config/config.default.js for more detail.
API
- ctx.acceptJSONP - detect if response should be jsonp, readonly
Example
In app/router.js
// Create once and use in any router you want to support jsonp.const jsonp = app;app;app; // Customize by create another jsonp middleware with specific sonfigurations.app;
Questions & Suggestions
Please open an issue here.