鸭子🦆的项目README文件（中文版）

项目概述

鸭子（Duck） 是一个功能强大的工具集合，旨在帮助用户高效地进行网络搜索、URL内容抓取以及元数据提取。该项目由 @OEvortex 开发，并通过 Apache License 2.0 许可证发布。

功能特点

• 网络搜索工具：支持自定义查询参数，返回指定数量的搜索结果。
• URL内容抓取：提取网页主内容，支持多种格式输出。
• 元数据提取：快速获取目标 URL 的标题、描述等基本信息。

更多详细功能请参考下方的工具说明。

快速上手指南

安装

npm install duck

使用示例

1. 网络搜索

const { webSearch } = require('duck');

webSearch({
  query: '人工智能',
  numResults: 5,
  page: 2
}).then(results => {
  console.log(results);
});

2. URL内容抓取

const { fetchUrl } = require('duck');

fetchUrl({
  url: 'https://example.com',
  maxLength: 10000
}).then(content => {
  console.log(content);
});

工具说明

网络搜索工具 (web-search)

• 参数：
  • query（必填）：搜索关键词。
  • page（可选，默认为1）：页码。
  • numResults（可选，默认为10）：结果数量（范围1-20）。

URL内容抓取工具 (fetch-url)

• 参数：
  • url（必填）：目标网页地址。
  • maxLength（可选，默认为10000）：最大返回长度。
  • extractMainContent（可选，默认为true）：是否提取主内容。
  • includeLinks（可选，默认为true）：是否包含链接文本。
  • includeImages（可选，默认为true）：是否包含图片描述。
  • excludeTags（可选）：排除特定标签。

元数据提取工具 (url-metadata)

• 参数：
  • url（必填）：目标网页地址。

项目结构

bin/              # 命令行接口
src/
  index.js        # 主入口文件
  tools/          # 工具定义与实现
    searchTool.js
    fetchUrlTool.js
    metadataTool.js
  utils/          # 辅助工具与函数
    search.js     # 搜索与URL相关功能
package.json
README.md

贡献指南

欢迎社区贡献！请通过提交问题或Pull Request参与项目。

注意：请遵循现有代码风格，并为新功能添加测试用例。

YouTube频道

@OEvortex

许可证

本项目使用 Apache License 2.0 协议，具体内容请参考 LICENSE 文件。

由 @OEvortex 开发 ❤️