perf: 优化注释

ikenxuan · Jan 13, 2025 · 06c569f · 06c569f
1 parent 8df3c42
commit 06c569f
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 4 deletions.
diff --git a/src/model/DataFetchers.ts b/src/model/DataFetchers.ts
@@ -9,7 +9,7 @@ import { BilibiliDataOptions, BilibiliDataOptionsMap, DouyinDataOptions, DouyinD
  * @returns 返回接口的原始数据
  * @example
  * ```ts
- * const data = await amagi.getDouyinData('搜索数据', 'User Cookies', {
+ * const data = await getDouyinData('搜索数据', 'User Cookies', {
  *   query: '114514',
  *   number: 10
  * })
@@ -32,7 +32,7 @@ export const getDouyinData = async <T extends keyof DouyinDataOptionsMap> (
  * @returns 返回接口的原始数据
  * @example
  * ```ts
- * const data = await amagi.getBilibiliData('单个视频作品数据', 'User Cookies', {
+ * const data = await getBilibiliData('单个视频作品数据', 'User Cookies', {
  *   bvid: 'BV1fK4y1q79u'
  * })
  * ```
@@ -54,7 +54,7 @@ export async function getBilibiliData<T extends keyof BilibiliDataOptionsMap> (
  * @returns 返回接口的原始数据
  * @example
  * ```ts
- * const data = await amagi.getKuaishouData('单个视频作品数据', 'User Cookies', {
+ * const data = await getKuaishouData('单个视频作品数据', 'User Cookies', {
  *   photoId: '3xdpv6sfi8yjsqy'
  * })
  * ```

diff --git a/src/server/client.ts b/src/server/client.ts
@@ -100,6 +100,11 @@ export class amagi {
    * @returns 返回接口的原始数据
    * @example
    * ```ts
+   * import Client from '@ikenxuan/amagi'
+   *
+   * const amagi = new Client({
+   *  douyin: '' // 有效的抖音ck
+   * })
    * const data = await amagi.getDouyinData('搜索数据', {
    *   query: '114514',
    *   number: 10
@@ -124,8 +129,13 @@ export class amagi {
    * @returns 返回接口的原始数据
    * @example
    * ```ts
+   * import Client from '@ikenxuan/amagi'
+   *
+   * const amagi = new Client({
+   *  bilibili: '' // 有效的B站ck
+   * })
    * const data = await amagi.getBilibiliData('单个视频作品数据', {
-   *   bvid: 'BV1fK4y1q79u'
+   *  bvid: 'BV1fK4y1q79u'
    * })
    * ```
    */
@@ -147,6 +157,11 @@ export class amagi {
    * @returns 返回接口的原始数据
    * @example
    * ```ts
+   * import Client from '@ikenxuan/amagi'
+   *
+   * const amagi = new Client({
+   *  kuaishou: '' // 有效的快手ck
+   * })
    * const data = await amagi.getKuaishouData('单个视频作品数据', {
    *   photoId: '3xdpv6sfi8yjsqy'
    * })