@polyv/request-plugin-global-params
v2.8.1
Published
用途:全局 `params` 参数插件,使用后会在所有请求的 params 中插入 `globalParams` 的数据。
Readme
GlobalParamsRequestPlugin
用途:全局 params 参数插件,使用后会在所有请求的 params 中插入 globalParams 的数据。
实例化参数
| 参数名 | 用途 | 类型 | 默认值 |
| ----------------- | ------------------------ | -------------------- | ------ |
| useGlobalParams | 是否使用全局 params 参数 | boolean | true |
| globalParams | 全局参数 | object \| function | - |
请求选项
| 参数名 | 用途 | 类型 | 默认值 |
| ----------------- | ------------------------ | --------- | ------ |
| useGlobalParams | 是否使用全局 params 参数 | boolean | true |
使用方式
import { PolyvRequest } from '@polyv/request-core';
import { GlobalParamsRequestPlugin } from '@polyv/request-plugin-global-params';
// 直接传入对象
const requester = new PolyvRequest({
requestPlugins: [
new GlobalParamsRequestPlugin({
globalParams: {
viewerId: 'xxx',
channelId: 'xxx',
},
}),
],
});
// 传入方法,支持返回 Promise
const requester = new PolyvRequest({
requestPlugins: [
new GlobalParamsRequestPlugin({
globalParams: async options => {
return {
viewerId: 'xxx',
channelId: 'xxx',
};
},
}),
],
});
// 如果你想在某个请求中,不带全局参数时
requester.get(
'/xxxx',
{},
{
useGlobalParams: false,
},
);