✨ feat: rename to getPluginSettingsFromRequest

lobehub · Sep 5, 2023 · 3969457 · 3969457
1 parent b4afc5e
commit 3969457
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/docs/api/request.md b/docs/api/request.md
@@ -1,5 +1,5 @@
 ---
-title: getPluginSettingsStringFromRequest
+title: getPluginSettingsFromRequest
 description: 从请求中获取插件设置字符串
 group:
   title: 服务端
@@ -12,7 +12,7 @@ nav: API
 ## 语法
 
 ```ts
-const settings = getPluginSettingsStringFromRequest<T>(req: Request): T | undefined;
+const settings = getPluginSettingsFromRequest<T>(req: Request): T | undefined;
 ```
 
 ## 参数
@@ -30,14 +30,14 @@ const settings = getPluginSettingsStringFromRequest<T>(req: Request): T | undefi
 ```ts
 import {
   createHeadersWithPluginSettings,
-  getPluginSettingsStringFromRequest,
+  getPluginSettingsFromRequest,
 } from '@lobehub/chat-plugin-sdk';
 
 const req = new Request('https://api.example.com', {
   headers: createHeadersWithPluginSettings({ theme: 'dark' }),
 });
 
-const settings = getPluginSettingsStringFromRequest(req);
+const settings = getPluginSettingsFromRequest(req);
 
 console.log(settings); // 输出: { theme: "dark" }
 ```

diff --git a/src/request.ts b/src/request.ts
@@ -1,6 +1,6 @@
 export const LOBE_PLUGIN_SETTINGS = 'X-LOBE_PLUGIN_SETTINGS';
 
-export const getPluginSettingsStringFromRequest = <T = any>(req: Request): T | undefined => {
+export const getPluginSettingsFromRequest = <T = any>(req: Request): T | undefined => {
   const settings = req.headers.get(LOBE_PLUGIN_SETTINGS);
   if (!settings) return;