函数 createAmagiClient

返回 {
    startServer: (port?: number) => Application;
    events: TypedEventEmitter;
    on: <K extends AmagiEventType>(
        event: K,
        listener: (data: AmagiEventMap[K]) => void,
    ) => this;
    once: <K extends AmagiEventType>(
        event: K,
        listener: (data: AmagiEventMap[K]) => void,
    ) => this;
    getDouyinData: (..._args: any[]) => never;
    getBilibiliData: (..._args: any[]) => never;
    getKuaishouData: (..._args: any[]) => never;
    getXiaohongshuData: (..._args: any[]) => never;
    douyin: {
        sign: typeof douyinSign;
        douyinApiUrls: DouyinAPI;
        api: {
            getTextWorkInfo: (..._args: any[]) => never;
            getWorkInfo: (..._args: any[]) => never;
            getVideoWorkInfo: (..._args: any[]) => never;
            getImageAlbumWorkInfo: (..._args: any[]) => never;
            getSlidesWorkInfo: (..._args: any[]) => never;
            getComments: (..._args: any[]) => never;
            getCommentReplies: (..._args: any[]) => never;
            getUserProfile: (..._args: any[]) => never;
            getEmojiList: (..._args: any[]) => never;
            getEmojiProList: (..._args: any[]) => never;
            getUserVideos: (..._args: any[]) => never;
            getMusicInfo: (..._args: any[]) => never;
            getSuggestWords: (..._args: any[]) => never;
            search: (..._args: any[]) => never;
            getLiveRoomInfo: (..._args: any[]) => never;
            getDanmaku: (..._args: any[]) => never;
            invoke: (..._args: any[]) => never;
            getSearchData: (..._args: any[]) => never;
        };
        fetcher: IBoundDouyinFetcher;
    };
    bilibili: {
        sign: {
            wbi_sign: (BASEURL: string | URL, cookie: string) => Promise<string>;
            av2bv: (aid: number) => `BV1${string}`;
            bv2av: (bvid: string) => number;
        };
        danmaku: {
            parseDmSegMobileReply: (
                data: ArrayBuffer | Uint8Array<ArrayBufferLike>,
            ) => Elem;
        };
        bilibiliApiUrls: BilibiliAPI;
        api: {
            getVideoInfo: (..._args: any[]) => never;
            getVideoStream: (..._args: any[]) => never;
            getComments: (..._args: any[]) => never;
            getCommentReply: (..._args: any[]) => never;
            getUserProfile: (..._args: any[]) => never;
            getUserDynamic: (..._args: any[]) => never;
            getEmojiList: (..._args: any[]) => never;
            getBangumiInfo: (..._args: any[]) => never;
            getBangumiStream: (..._args: any[]) => never;
            getDynamicInfo: (..._args: any[]) => never;
            getDynamicCard: (..._args: any[]) => never;
            getLiveRoomDetail: (..._args: any[]) => never;
            getLiveRoomInitInfo: (..._args: any[]) => never;
            getLoginBasicInfo: (..._args: any[]) => never;
            getLoginQrcode: (..._args: any[]) => never;
            checkQrcodeStatus: (..._args: any[]) => never;
            getUserTotalPlayCount: (..._args: any[]) => never;
            convertAvToBv: (..._args: any[]) => never;
            convertBvToAv: (..._args: any[]) => never;
            getArticleContent: (..._args: any[]) => never;
            getArticleCard: (..._args: any[]) => never;
            getArticleInfo: (..._args: any[]) => never;
            getColumnInfo: (..._args: any[]) => never;
            getUserProfileDetail: (..._args: any[]) => never;
            applyVoucherCaptcha: (..._args: any[]) => never;
            validateCaptcha: (..._args: any[]) => never;
            getDanmaku: (..._args: any[]) => never;
        };
        fetcher: IBoundBilibiliFetcher;
    };
    kuaishou: {
        kuaishouApiUrls: API;
        api: {
            getWorkInfo: (..._args: any[]) => never;
            getComments: (..._args: any[]) => never;
            getEmojiList: (..._args: any[]) => never;
        };
        fetcher: IBoundKuaishouFetcher;
    };
    xiaohongshu: {
        sign: typeof xiaohongshuSign;
        xiaohongshuApiUrls: {
            homeFeed(
                data?: Omit<
                    {
                        methodType: "homeFeed";
                        cursor_score?: string;
                        num?: number;
                        refresh_type?: number;
                        note_index?: number;
                        category?: string;
                        search_key?: string;
                    },
                    "methodType",
                >,
            ): {
                apiPath: string;
                Url: string;
                Body: {
                    cursor_score: string;
                    num: number;
                    refresh_type: number;
                    note_index: number;
                    category: string;
                    search_key: string;
                    image_formats: string[];
                };
            };
            noteDetail(
                data: Omit<
                    { methodType: "noteDetail"; note_id: string; xsec_token: string },
                    "methodType",
                >,
            ): {
                apiPath: string;
                Url: string;
                Body: {
                    source_note_id: string;
                    image_formats: string[];
                    extra: { need_body_topic: string };
                    xsec_source: string;
                    xsec_token: string;
                };
            };
            noteComments(
                data: Omit<
                    {
                        methodType: "noteComments";
                        note_id: string;
                        cursor?: string;
                        xsec_token: string;
                    },
                    "methodType",
                >,
            ): { apiPath: string; Url: string };
            userProfile(
                data: Omit<
                    { methodType: "userProfile"; user_id: string },
                    "methodType",
                >,
            ): { apiPath: string; Url: string };
            userNoteList(
                data: Omit<
                    {
                        methodType: "userNoteList";
                        user_id: string;
                        cursor?: string;
                        num?: number;
                    },
                    "methodType",
                >,
            ): { apiPath: string; Url: string };
            emojiList(
                data: Omit<{ methodType: "emojiList" }, "methodType">,
            ): { apiPath: string; Url: string };
            searchNotes(
                data: Omit<
                    {
                        methodType: "searchNotes";
                        keyword: string;
                        page?: number;
                        page_size?: number;
                        sort?: SearchSortType;
                        note_type?: SearchNoteType;
                    },
                    "methodType",
                >,
            ): {
                apiPath: string;
                Body: {
                    keyword: string;
                    page: number;
                    page_size: number;
                    sort: SearchSortType;
                    note_type: SearchNoteType;
                    search_id: string;
                    image_formats: string[];
                };
                Url: string;
            };
        };
        api: {
            getHomeFeed: (..._args: any[]) => never;
            getNote: (..._args: any[]) => never;
            getComments: (..._args: any[]) => never;
            getUser: (..._args: any[]) => never;
            getUserNotes: (..._args: any[]) => never;
            getSearchNotes: (..._args: any[]) => never;
            getEmojiList: (..._args: any[]) => never;
        };
        fetcher: IBoundXiaohongshuFetcher;
    };
}

包含数据获取方法、服务器启动方法、绑定Cookie的平台工具集和API对象的对象

• startServer: (port?: number) => Application

  启动本地HTTP服务

• events: TypedEventEmitter

  事件系统

• on: <K extends AmagiEventType>(
      event: K,
      listener: (data: AmagiEventMap[K]) => void,
  ) => this

  注册事件监听器

  参数: event

  事件名称

  参数: listener

  事件处理函数

• once: <K extends AmagiEventType>(
      event: K,
      listener: (data: AmagiEventMap[K]) => void,
  ) => this

  注册一次性事件监听器

  参数: event

  事件名称

  参数: listener

  事件处理函数 (只触发一次)

• getDouyinData: (..._args: any[]) => never

  已被弃用

  v6 已废弃，请使用 douyin.fetcher 替代

• getBilibiliData: (..._args: any[]) => never

  已被弃用

  v6 已废弃，请使用 bilibili.fetcher 替代

• getKuaishouData: (..._args: any[]) => never

  已被弃用

  v6 已废弃，请使用 kuaishou.fetcher 替代

• getXiaohongshuData: (..._args: any[]) => never

  已被弃用

  v6 已废弃，请使用 xiaohongshu.fetcher 替代

• douyin: {
      sign: typeof douyinSign;
      douyinApiUrls: DouyinAPI;
      api: {
          getTextWorkInfo: (..._args: any[]) => never;
          getWorkInfo: (..._args: any[]) => never;
          getVideoWorkInfo: (..._args: any[]) => never;
          getImageAlbumWorkInfo: (..._args: any[]) => never;
          getSlidesWorkInfo: (..._args: any[]) => never;
          getComments: (..._args: any[]) => never;
          getCommentReplies: (..._args: any[]) => never;
          getUserProfile: (..._args: any[]) => never;
          getEmojiList: (..._args: any[]) => never;
          getEmojiProList: (..._args: any[]) => never;
          getUserVideos: (..._args: any[]) => never;
          getMusicInfo: (..._args: any[]) => never;
          getSuggestWords: (..._args: any[]) => never;
          search: (..._args: any[]) => never;
          getLiveRoomInfo: (..._args: any[]) => never;
          getDanmaku: (..._args: any[]) => never;
          invoke: (..._args: any[]) => never;
          getSearchData: (..._args: any[]) => never;
      };
      fetcher: IBoundDouyinFetcher;
  }

  • sign: typeof douyinSign

    签名算法相关

  • douyinApiUrls: DouyinAPI

    该类下的所有方法只会返回拼接好参数后的 Url 地址，需要手动请求该地址以获取数据

    缺少 a_bougs 参数，请自行生成拼接

  • api: {
        getTextWorkInfo: (..._args: any[]) => never;
        getWorkInfo: (..._args: any[]) => never;
        getVideoWorkInfo: (..._args: any[]) => never;
        getImageAlbumWorkInfo: (..._args: any[]) => never;
        getSlidesWorkInfo: (..._args: any[]) => never;
        getComments: (..._args: any[]) => never;
        getCommentReplies: (..._args: any[]) => never;
        getUserProfile: (..._args: any[]) => never;
        getEmojiList: (..._args: any[]) => never;
        getEmojiProList: (..._args: any[]) => never;
        getUserVideos: (..._args: any[]) => never;
        getMusicInfo: (..._args: any[]) => never;
        getSuggestWords: (..._args: any[]) => never;
        search: (..._args: any[]) => never;
        getLiveRoomInfo: (..._args: any[]) => never;
        getDanmaku: (..._args: any[]) => never;
        invoke: (..._args: any[]) => never;
        getSearchData: (..._args: any[]) => never;
    }

    已被弃用

    请使用 fetcher 替代

    • getTextWorkInfo: (..._args: any[]) => never

      已被弃用

      请使用 douyinFetcher.fetchTextWork 替代

    • getWorkInfo: (..._args: any[]) => never

      已被弃用

      请使用 douyinFetcher.parseWork 替代

    • getVideoWorkInfo: (..._args: any[]) => never

      已被弃用

      请使用 douyinFetcher.fetchVideoWork 替代

    • getImageAlbumWorkInfo: (..._args: any[]) => never

      已被弃用

      请使用 douyinFetcher.fetchImageAlbumWork 替代

    • getSlidesWorkInfo: (..._args: any[]) => never

      已被弃用

      请使用 douyinFetcher.fetchSlidesWork 替代

    • getComments: (..._args: any[]) => never

      已被弃用

      请使用 douyinFetcher.fetchComments 替代

    • getCommentReplies: (..._args: any[]) => never

      已被弃用

      请使用 douyinFetcher.fetchCommentReplies 替代

    • getUserProfile: (..._args: any[]) => never

      已被弃用

      请使用 douyinFetcher.fetchUserProfile 替代

    • getEmojiList: (..._args: any[]) => never

      已被弃用

      请使用 douyinFetcher.fetchEmojiList 替代

    • getEmojiProList: (..._args: any[]) => never

      已被弃用

      请使用 douyinFetcher.fetchDynamicEmojiList 替代

    • getUserVideos: (..._args: any[]) => never

      已被弃用

      请使用 douyinFetcher.fetchUserVideoList 替代

    • getMusicInfo: (..._args: any[]) => never

      已被弃用

      请使用 douyinFetcher.fetchMusicInfo 替代

    • getSuggestWords: (..._args: any[]) => never

      已被弃用

      请使用 douyinFetcher.fetchSuggestWords 替代

    • search: (..._args: any[]) => never

      已被弃用

      请使用 douyinFetcher.searchContent 替代

    • getLiveRoomInfo: (..._args: any[]) => never

      已被弃用

      请使用 douyinFetcher.fetchLiveRoomInfo 替代

    • getDanmaku: (..._args: any[]) => never

      已被弃用

      请使用 douyinFetcher.fetchDanmakuList 替代

    • invoke: (..._args: any[]) => never

      已被弃用

      请使用 douyinFetcher 的具体方法替代

    • getSearchData: (..._args: any[]) => never

  • fetcher: IBoundDouyinFetcher

    v6 新 API - 绑定了 cookie 的英文方法名 fetcher

• bilibili: {
      sign: {
          wbi_sign: (BASEURL: string | URL, cookie: string) => Promise<string>;
          av2bv: (aid: number) => `BV1${string}`;
          bv2av: (bvid: string) => number;
      };
      danmaku: {
          parseDmSegMobileReply: (
              data: ArrayBuffer | Uint8Array<ArrayBufferLike>,
          ) => Elem;
      };
      bilibiliApiUrls: BilibiliAPI;
      api: {
          getVideoInfo: (..._args: any[]) => never;
          getVideoStream: (..._args: any[]) => never;
          getComments: (..._args: any[]) => never;
          getCommentReply: (..._args: any[]) => never;
          getUserProfile: (..._args: any[]) => never;
          getUserDynamic: (..._args: any[]) => never;
          getEmojiList: (..._args: any[]) => never;
          getBangumiInfo: (..._args: any[]) => never;
          getBangumiStream: (..._args: any[]) => never;
          getDynamicInfo: (..._args: any[]) => never;
          getDynamicCard: (..._args: any[]) => never;
          getLiveRoomDetail: (..._args: any[]) => never;
          getLiveRoomInitInfo: (..._args: any[]) => never;
          getLoginBasicInfo: (..._args: any[]) => never;
          getLoginQrcode: (..._args: any[]) => never;
          checkQrcodeStatus: (..._args: any[]) => never;
          getUserTotalPlayCount: (..._args: any[]) => never;
          convertAvToBv: (..._args: any[]) => never;
          convertBvToAv: (..._args: any[]) => never;
          getArticleContent: (..._args: any[]) => never;
          getArticleCard: (..._args: any[]) => never;
          getArticleInfo: (..._args: any[]) => never;
          getColumnInfo: (..._args: any[]) => never;
          getUserProfileDetail: (..._args: any[]) => never;
          applyVoucherCaptcha: (..._args: any[]) => never;
          validateCaptcha: (..._args: any[]) => never;
          getDanmaku: (..._args: any[]) => never;
      };
      fetcher: IBoundBilibiliFetcher;
  }

  • sign: {
        wbi_sign: (BASEURL: string | URL, cookie: string) => Promise<string>;
        av2bv: (aid: number) => `BV1${string}`;
        bv2av: (bvid: string) => number;
    }

    签名算法相关

    • wbi_sign: (BASEURL: string | URL, cookie: string) => Promise<string>

      WBI签名算法

    • av2bv: (aid: number) => `BV1${string}`

      AV号转BV号

    • bv2av: (bvid: string) => number

      BV号转AV号

  • danmaku: {
        parseDmSegMobileReply: (
            data: ArrayBuffer | Uint8Array<ArrayBufferLike>,
        ) => Elem;
    }

    弹幕解析相关

    • parseDmSegMobileReply: (data: ArrayBuffer | Uint8Array<ArrayBufferLike>) => Elem

      解析弹幕 protobuf 数据

  • bilibiliApiUrls: BilibiliAPI

    该类下的所有方法只会返回拼接好参数后的 Url 地址，需要手动请求该地址以获取数据

  • api: {
        getVideoInfo: (..._args: any[]) => never;
        getVideoStream: (..._args: any[]) => never;
        getComments: (..._args: any[]) => never;
        getCommentReply: (..._args: any[]) => never;
        getUserProfile: (..._args: any[]) => never;
        getUserDynamic: (..._args: any[]) => never;
        getEmojiList: (..._args: any[]) => never;
        getBangumiInfo: (..._args: any[]) => never;
        getBangumiStream: (..._args: any[]) => never;
        getDynamicInfo: (..._args: any[]) => never;
        getDynamicCard: (..._args: any[]) => never;
        getLiveRoomDetail: (..._args: any[]) => never;
        getLiveRoomInitInfo: (..._args: any[]) => never;
        getLoginBasicInfo: (..._args: any[]) => never;
        getLoginQrcode: (..._args: any[]) => never;
        checkQrcodeStatus: (..._args: any[]) => never;
        getUserTotalPlayCount: (..._args: any[]) => never;
        convertAvToBv: (..._args: any[]) => never;
        convertBvToAv: (..._args: any[]) => never;
        getArticleContent: (..._args: any[]) => never;
        getArticleCard: (..._args: any[]) => never;
        getArticleInfo: (..._args: any[]) => never;
        getColumnInfo: (..._args: any[]) => never;
        getUserProfileDetail: (..._args: any[]) => never;
        applyVoucherCaptcha: (..._args: any[]) => never;
        validateCaptcha: (..._args: any[]) => never;
        getDanmaku: (..._args: any[]) => never;
    }

    已被弃用

    请使用 fetcher 替代

    • getVideoInfo: (..._args: any[]) => never

      已被弃用

      请使用 bilibiliFetcher.fetchVideoInfo 替代

    • getVideoStream: (..._args: any[]) => never

      已被弃用

      请使用 bilibiliFetcher.fetchVideoStreamUrl 替代

    • getComments: (..._args: any[]) => never

      已被弃用

      请使用 bilibiliFetcher.fetchComments 替代

    • getCommentReply: (..._args: any[]) => never

      已被弃用

      请使用 bilibiliFetcher.fetchCommentReplies 替代

    • getUserProfile: (..._args: any[]) => never

      已被弃用

      请使用 bilibiliFetcher.fetchUserCard 替代

    • getUserDynamic: (..._args: any[]) => never

      已被弃用

      请使用 bilibiliFetcher.fetchUserDynamicList 替代

    • getEmojiList: (..._args: any[]) => never

      已被弃用

      请使用 bilibiliFetcher.fetchEmojiList 替代

    • getBangumiInfo: (..._args: any[]) => never

      已被弃用

      请使用 bilibiliFetcher.fetchBangumiInfo 替代

    • getBangumiStream: (..._args: any[]) => never

      已被弃用

      请使用 bilibiliFetcher.fetchBangumiStreamUrl 替代

    • getDynamicInfo: (..._args: any[]) => never

      已被弃用

      请使用 bilibiliFetcher.fetchDynamicDetail 替代

    • getDynamicCard: (..._args: any[]) => never

      已被弃用

      请使用 bilibiliFetcher.fetchDynamicCard 替代

    • getLiveRoomDetail: (..._args: any[]) => never

      已被弃用

      请使用 bilibiliFetcher.fetchLiveRoomInfo 替代

    • getLiveRoomInitInfo: (..._args: any[]) => never

      已被弃用

      请使用 bilibiliFetcher.fetchLiveRoomInitInfo 替代

    • getLoginBasicInfo: (..._args: any[]) => never

      已被弃用

      请使用 bilibiliFetcher.fetchLoginStatus 替代

    • getLoginQrcode: (..._args: any[]) => never

      已被弃用

      请使用 bilibiliFetcher.requestLoginQrcode 替代

    • checkQrcodeStatus: (..._args: any[]) => never

      已被弃用

      请使用 bilibiliFetcher.checkQrcodeStatus 替代

    • getUserTotalPlayCount: (..._args: any[]) => never

      已被弃用

      请使用 bilibiliFetcher.fetchUploaderTotalViews 替代

    • convertAvToBv: (..._args: any[]) => never

      已被弃用

      请使用 bilibiliFetcher.convertAvToBv 替代

    • convertBvToAv: (..._args: any[]) => never

      已被弃用

      请使用 bilibiliFetcher.convertBvToAv 替代

    • getArticleContent: (..._args: any[]) => never

      已被弃用

      请使用 bilibiliFetcher.fetchArticleContent 替代

    • getArticleCard: (..._args: any[]) => never

      已被弃用

      请使用 bilibiliFetcher.fetchArticleCards 替代

    • getArticleInfo: (..._args: any[]) => never

      已被弃用

      请使用 bilibiliFetcher.fetchArticleInfo 替代

    • getColumnInfo: (..._args: any[]) => never

      已被弃用

      请使用 bilibiliFetcher.fetchArticleListInfo 替代

    • getUserProfileDetail: (..._args: any[]) => never

      已被弃用

      请使用 bilibiliFetcher.fetchUserSpaceInfo 替代

    • applyVoucherCaptcha: (..._args: any[]) => never

      已被弃用

      请使用 bilibiliFetcher.requestCaptchaFromVoucher 替代

    • validateCaptcha: (..._args: any[]) => never

      已被弃用

      请使用 bilibiliFetcher.validateCaptchaResult 替代

    • getDanmaku: (..._args: any[]) => never

      已被弃用

      请使用 bilibiliFetcher.fetchVideoDanmaku 替代

  • fetcher: IBoundBilibiliFetcher

    v6 新 API - 绑定了 cookie 的英文方法名 fetcher

• kuaishou: {
      kuaishouApiUrls: API;
      api: {
          getWorkInfo: (..._args: any[]) => never;
          getComments: (..._args: any[]) => never;
          getEmojiList: (..._args: any[]) => never;
      };
      fetcher: IBoundKuaishouFetcher;
  }

  • kuaishouApiUrls: API

    该类下的所有方法只会返回拼接好参数后的 Url 地址和请求体，需要手动请求该地址以获取数据

  • api: {
        getWorkInfo: (..._args: any[]) => never;
        getComments: (..._args: any[]) => never;
        getEmojiList: (..._args: any[]) => never;
    }

    已被弃用

    请使用 fetcher 替代

    • getWorkInfo: (..._args: any[]) => never

      已被弃用

      请使用 kuaishouFetcher.fetchVideoWork 替代

    • getComments: (..._args: any[]) => never

      已被弃用

      请使用 kuaishouFetcher.fetchComments 替代

    • getEmojiList: (..._args: any[]) => never

      已被弃用

      请使用 kuaishouFetcher.fetchEmojiList 替代

  • fetcher: IBoundKuaishouFetcher

    v6 新 API - 绑定了 cookie 的英文方法名 fetcher

• xiaohongshu: {
      sign: typeof xiaohongshuSign;
      xiaohongshuApiUrls: {
          homeFeed(
              data?: Omit<
                  {
                      methodType: "homeFeed";
                      cursor_score?: string;
                      num?: number;
                      refresh_type?: number;
                      note_index?: number;
                      category?: string;
                      search_key?: string;
                  },
                  "methodType",
              >,
          ): {
              apiPath: string;
              Url: string;
              Body: {
                  cursor_score: string;
                  num: number;
                  refresh_type: number;
                  note_index: number;
                  category: string;
                  search_key: string;
                  image_formats: string[];
              };
          };
          noteDetail(
              data: Omit<
                  { methodType: "noteDetail"; note_id: string; xsec_token: string },
                  "methodType",
              >,
          ): {
              apiPath: string;
              Url: string;
              Body: {
                  source_note_id: string;
                  image_formats: string[];
                  extra: { need_body_topic: string };
                  xsec_source: string;
                  xsec_token: string;
              };
          };
          noteComments(
              data: Omit<
                  {
                      methodType: "noteComments";
                      note_id: string;
                      cursor?: string;
                      xsec_token: string;
                  },
                  "methodType",
              >,
          ): { apiPath: string; Url: string };
          userProfile(
              data: Omit<
                  { methodType: "userProfile"; user_id: string },
                  "methodType",
              >,
          ): { apiPath: string; Url: string };
          userNoteList(
              data: Omit<
                  {
                      methodType: "userNoteList";
                      user_id: string;
                      cursor?: string;
                      num?: number;
                  },
                  "methodType",
              >,
          ): { apiPath: string; Url: string };
          emojiList(
              data: Omit<{ methodType: "emojiList" }, "methodType">,
          ): { apiPath: string; Url: string };
          searchNotes(
              data: Omit<
                  {
                      methodType: "searchNotes";
                      keyword: string;
                      page?: number;
                      page_size?: number;
                      sort?: SearchSortType;
                      note_type?: SearchNoteType;
                  },
                  "methodType",
              >,
          ): {
              apiPath: string;
              Body: {
                  keyword: string;
                  page: number;
                  page_size: number;
                  sort: SearchSortType;
                  note_type: SearchNoteType;
                  search_id: string;
                  image_formats: string[];
              };
              Url: string;
          };
      };
      api: {
          getHomeFeed: (..._args: any[]) => never;
          getNote: (..._args: any[]) => never;
          getComments: (..._args: any[]) => never;
          getUser: (..._args: any[]) => never;
          getUserNotes: (..._args: any[]) => never;
          getSearchNotes: (..._args: any[]) => never;
          getEmojiList: (..._args: any[]) => never;
      };
      fetcher: IBoundXiaohongshuFetcher;
  }

  • sign: typeof xiaohongshuSign

    签名算法相关

  • xiaohongshuApiUrls: {
        homeFeed(
            data?: Omit<
                {
                    methodType: "homeFeed";
                    cursor_score?: string;
                    num?: number;
                    refresh_type?: number;
                    note_index?: number;
                    category?: string;
                    search_key?: string;
                },
                "methodType",
            >,
        ): {
            apiPath: string;
            Url: string;
            Body: {
                cursor_score: string;
                num: number;
                refresh_type: number;
                note_index: number;
                category: string;
                search_key: string;
                image_formats: string[];
            };
        };
        noteDetail(
            data: Omit<
                { methodType: "noteDetail"; note_id: string; xsec_token: string },
                "methodType",
            >,
        ): {
            apiPath: string;
            Url: string;
            Body: {
                source_note_id: string;
                image_formats: string[];
                extra: { need_body_topic: string };
                xsec_source: string;
                xsec_token: string;
            };
        };
        noteComments(
            data: Omit<
                {
                    methodType: "noteComments";
                    note_id: string;
                    cursor?: string;
                    xsec_token: string;
                },
                "methodType",
            >,
        ): { apiPath: string; Url: string };
        userProfile(
            data: Omit<
                { methodType: "userProfile"; user_id: string },
                "methodType",
            >,
        ): { apiPath: string; Url: string };
        userNoteList(
            data: Omit<
                {
                    methodType: "userNoteList";
                    user_id: string;
                    cursor?: string;
                    num?: number;
                },
                "methodType",
            >,
        ): { apiPath: string; Url: string };
        emojiList(
            data: Omit<{ methodType: "emojiList" }, "methodType">,
        ): { apiPath: string; Url: string };
        searchNotes(
            data: Omit<
                {
                    methodType: "searchNotes";
                    keyword: string;
                    page?: number;
                    page_size?: number;
                    sort?: SearchSortType;
                    note_type?: SearchNoteType;
                },
                "methodType",
            >,
        ): {
            apiPath: string;
            Body: {
                keyword: string;
                page: number;
                page_size: number;
                sort: SearchSortType;
                note_type: SearchNoteType;
                search_id: string;
                image_formats: string[];
            };
            Url: string;
        };
    }

    该类下的所有方法只会返回拼接好参数后的 Url 地址，需要手动请求该地址以获取数据

    • homeFeed: function

      • homeFeed(
            data?: Omit<
                {
                    methodType: "homeFeed";
                    cursor_score?: string;
                    num?: number;
                    refresh_type?: number;
                    note_index?: number;
                    category?: string;
                    search_key?: string;
                },
                "methodType",
            >,
        ): {
            apiPath: string;
            Url: string;
            Body: {
                cursor_score: string;
                num: number;
                refresh_type: number;
                note_index: number;
                category: string;
                search_key: string;
                image_formats: string[];
            };
        }

        获取首页推荐数据的接口地址

        参数

        • data: Omit<
              {
                  methodType: "homeFeed";
                  cursor_score?: string;
                  num?: number;
                  refresh_type?: number;
                  note_index?: number;
                  category?: string;
                  search_key?: string;
              },
              "methodType",
          > = {}

          请求参数

        返回 {
            apiPath: string;
            Url: string;
            Body: {
                cursor_score: string;
                num: number;
                refresh_type: number;
                note_index: number;
                category: string;
                search_key: string;
                image_formats: string[];
            };
        }

        完整的接口URL

    • noteDetail: function

      • noteDetail(
            data: Omit<
                { methodType: "noteDetail"; note_id: string; xsec_token: string },
                "methodType",
            >,
        ): {
            apiPath: string;
            Url: string;
            Body: {
                source_note_id: string;
                image_formats: string[];
                extra: { need_body_topic: string };
                xsec_source: string;
                xsec_token: string;
            };
        }

        获取单个笔记数据的接口地址

        参数

        • data: Omit<
              { methodType: "noteDetail"; note_id: string; xsec_token: string },
              "methodType",
          >

          请求参数

        返回 {
            apiPath: string;
            Url: string;
            Body: {
                source_note_id: string;
                image_formats: string[];
                extra: { need_body_topic: string };
                xsec_source: string;
                xsec_token: string;
            };
        }

        完整的接口URL

    • noteComments: function

      • noteComments(
            data: Omit<
                {
                    methodType: "noteComments";
                    note_id: string;
                    cursor?: string;
                    xsec_token: string;
                },
                "methodType",
            >,
        ): { apiPath: string; Url: string }

        获取评论数据的接口地址

        参数

        • data: Omit<
              {
                  methodType: "noteComments";
                  note_id: string;
                  cursor?: string;
                  xsec_token: string;
              },
              "methodType",
          >

          请求参数

        返回 { apiPath: string; Url: string }

        完整的接口URL

    • userProfile: function

      • userProfile(
            data: Omit<{ methodType: "userProfile"; user_id: string }, "methodType">,
        ): { apiPath: string; Url: string }

        获取用户数据的接口地址

        参数

        • data: Omit<{ methodType: "userProfile"; user_id: string }, "methodType">

          请求参数

        返回 { apiPath: string; Url: string }

        完整的接口URL

    • userNoteList: function

      • userNoteList(
            data: Omit<
                {
                    methodType: "userNoteList";
                    user_id: string;
                    cursor?: string;
                    num?: number;
                },
                "methodType",
            >,
        ): { apiPath: string; Url: string }

        获取用户笔记数据的接口地址

        参数

        • data: Omit<
              {
                  methodType: "userNoteList";
                  user_id: string;
                  cursor?: string;
                  num?: number;
              },
              "methodType",
          >

          请求参数

        返回 { apiPath: string; Url: string }

        完整的接口URL

    • emojiList: function

      • emojiList(
            data: Omit<{ methodType: "emojiList" }, "methodType">,
        ): { apiPath: string; Url: string }

        获取笔记表情列表的接口地址

        参数

        • data: Omit<{ methodType: "emojiList" }, "methodType">

          请求参数

        返回 { apiPath: string; Url: string }

        完整的接口URL

    • searchNotes: function

      • searchNotes(
            data: Omit<
                {
                    methodType: "searchNotes";
                    keyword: string;
                    page?: number;
                    page_size?: number;
                    sort?: SearchSortType;
                    note_type?: SearchNoteType;
                },
                "methodType",
            >,
        ): {
            apiPath: string;
            Body: {
                keyword: string;
                page: number;
                page_size: number;
                sort: SearchSortType;
                note_type: SearchNoteType;
                search_id: string;
                image_formats: string[];
            };
            Url: string;
        }

        搜索笔记的接口地址

        参数

        • data: Omit<
              {
                  methodType: "searchNotes";
                  keyword: string;
                  page?: number;
                  page_size?: number;
                  sort?: SearchSortType;
                  note_type?: SearchNoteType;
              },
              "methodType",
          >

          请求参数

        返回 {
            apiPath: string;
            Body: {
                keyword: string;
                page: number;
                page_size: number;
                sort: SearchSortType;
                note_type: SearchNoteType;
                search_id: string;
                image_formats: string[];
            };
            Url: string;
        }

        完整的接口URL

  • api: {
        getHomeFeed: (..._args: any[]) => never;
        getNote: (..._args: any[]) => never;
        getComments: (..._args: any[]) => never;
        getUser: (..._args: any[]) => never;
        getUserNotes: (..._args: any[]) => never;
        getSearchNotes: (..._args: any[]) => never;
        getEmojiList: (..._args: any[]) => never;
    }

    已被弃用

    请使用 fetcher 替代

    • getHomeFeed: (..._args: any[]) => never

      已被弃用

      请使用 xiaohongshuFetcher.fetchHomeFeed 替代

    • getNote: (..._args: any[]) => never

      已被弃用

      请使用 xiaohongshuFetcher.fetchNoteDetail 替代

    • getComments: (..._args: any[]) => never

      已被弃用

      请使用 xiaohongshuFetcher.fetchNoteComments 替代

    • getUser: (..._args: any[]) => never

      已被弃用

      请使用 xiaohongshuFetcher.fetchUserProfile 替代

    • getUserNotes: (..._args: any[]) => never

      已被弃用

      请使用 xiaohongshuFetcher.fetchUserNoteList 替代

    • getSearchNotes: (..._args: any[]) => never

      已被弃用

      请使用 xiaohongshuFetcher.searchNotes 替代

    • getEmojiList: (..._args: any[]) => never

      已被弃用

      请使用 xiaohongshuFetcher.fetchEmojiList 替代

  • fetcher: IBoundXiaohongshuFetcher

    v6 新 API - 绑定了 cookie 的英文方法名 fetcher