@polyv/request-plugin-global-params 2.0.0

package/README.md

@@ -0,0 +1,54 @@
+# GlobalParamsRequestPlugin
+
+用途：全局 `params` 参数插件，使用后会在所有请求的 params 中插入 `globalParams` 的数据。
+
+## 实例化参数
+
+| 参数名 | 用途 | 类型 | 默认值 |
+| - | - | - | - |
+| `useGlobalParams` | 是否使用全局 params 参数 | `boolean` | `true` |
+| `globalParams` | 全局参数 | `object \| function` | - |
+
+## 请求选项
+
+| 参数名 | 用途 | 类型 | 默认值 |
+| - | - | - | - |
+| `useGlobalParams` | 是否使用全局 params 参数 | `boolean` | `true` |
+
+## 使用方式
+
+```js
+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,
+});
+```

package/global-params.d.ts

@@ -0,0 +1,13 @@
+import type { RequestOptions, RequestPlugin } from '@polyv/request-core';
+import { GlobalParamsRequestPluginConfig } from './types';
+export * from './types';
+/**
+ * 全局 params 参数请求插件
+ */
+export declare class GlobalParamsRequestPlugin<Options extends RequestOptions = RequestOptions> implements RequestPlugin<Options> {
+    private __config;
+    private __useGlobalParams;
+    constructor(__config?: GlobalParamsRequestPluginConfig);
+    usePlugin(options: Options): boolean;
+    interceptIncludeParams(options: Options): Promise<object | undefined>;
+}

package/global-params.js

@@ -0,0 +1,28 @@
+export * from './types';
+/**
+ * 全局 params 参数请求插件
+ */
+export class GlobalParamsRequestPlugin {
+    __config;
+    __useGlobalParams;
+    constructor(__config = {}) {
+        this.__config = __config;
+        const { useGlobalParams = true } = __config;
+        this.__useGlobalParams = useGlobalParams;
+    }
+    usePlugin(options) {
+        const { useGlobalParams = this.__useGlobalParams } = options;
+        return useGlobalParams;
+    }
+    async interceptIncludeParams(options) {
+        let globalParams;
+        if (typeof this.__config.globalParams === 'function') {
+            globalParams = await this.__config.globalParams(options);
+        }
+        else {
+            globalParams = this.__config.globalParams;
+        }
+        // 插入额外的 params
+        return globalParams;
+    }
+}

package/index.d.ts

@@ -0,0 +1,3 @@
+export * from './global-params';
+export * from './types';
+export * from './request-options';

package/index.js

@@ -0,0 +1,3 @@
+export * from './global-params';
+export * from './types';
+export * from './request-options';

package/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "@polyv/request-plugin-global-params",
+  "version": "2.0.0",
+  "main": "./index.js",
+  "dependencies": {
+    "@polyv/request-core": "2.0.0"
+  },
+  "types": "./index.d.ts"
+}

package/request-options.d.ts

@@ -0,0 +1,16 @@
+export interface GlobalParamsRequestOptions {
+    /**
+     * 是否使用全局 params 参数
+     * @default true
+     * @plugin `GlobalParamsRequestPlugin`
+     */
+    useGlobalParams?: boolean;
+}
+declare module '@polyv/request-core' {
+    interface RequestCustomOptions extends GlobalParamsRequestOptions {
+    }
+}
+declare module 'axios' {
+    interface AxiosRequestConfig extends GlobalParamsRequestOptions {
+    }
+}

package/request-options.js

@@ -0,0 +1 @@
+export {};

package/types.d.ts

@@ -0,0 +1,12 @@
+import { RequestOptions, UniversalParams } from '@polyv/request-core';
+export interface GlobalParamsRequestPluginConfig<Options extends RequestOptions = RequestOptions> {
+    /**
+     * 是否使用全局 params 参数
+     * @default true
+     */
+    useGlobalParams?: boolean;
+    /**
+     * 全局参数
+     */
+    globalParams?: UniversalParams | ((options: Options) => Promise<UniversalParams | undefined> | UniversalParams | undefined);
+}

package/types.js

@@ -0,0 +1 @@
+export {};