# @distube/youtube 中文文档

规范地址：https://npmcn.com/package/%40distube/youtube/

版本：1\.1\.0
npm 元数据更新时间：2026-10-22T10:18:40.888Z
中文译文更新时间：2026-11-13T05:08:09.215Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40distube/youtube
原文对照：https://npmcn.com/package/%40distube/youtube/?lang=original
项目主页：https://github.com/distubejs/plugins/tree/main/packages/youtube#readme
源码仓库：https://github.com/distubejs/plugins

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：54.6 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：^22\.22\.2 \|\| ^24\.15\.0 \|\| \>=26\.0\.0
- 运行依赖：1 个
- peer 依赖：distube 5
- 首次发布：2024-06-04T07:42:24.420Z
- 最新版本发布：2026-10-22T09:35:23.789Z
- 近 30 天下载量：2249（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 1 个）

## 中文简介

一个支持YouTube的DisTube提取器插件.

## 安装

```sh
npm install @distube/youtube
```

也可以使用：`pnpm add @distube/youtube`、`yarn add @distube/youtube`、`bun add @distube/youtube`

## README

[![](https://nodei.co/npm/@distube/youtube.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/@distube/youtube)

[![npm peer dependency version](https://img.shields.io/npm/dependency-version/@distube/youtube/peer/distube?style=flat-square)](https://nodei.co/npm/@distube/youtube) [![npm](https://img.shields.io/npm/dt/@distube/youtube?logo=npm&style=flat-square)](https://nodei.co/npm/@distube/youtube) ![GitHub Repo stars](https://img.shields.io/github/stars/distubejs/plugins?logo=github&logoColor=white&style=flat-square) [![Discord](https://img.shields.io/discord/732254550689316914?logo=discord&logoColor=white&style=flat-square)](https://discord.gg/feaDd9h)

[![Buy Me a Coffee at ko-fi.com](https://storage.ko-fi.com/cdn/kofi3.png)](https://ko-fi.com/skick)

# @distube/ youtube (英语)

一个支持YouTube的DisTube提取器插件.

[_什么是提取器插件?_](https://github.com/skick1234/DisTube/wiki/Projects-Hub#plugins)

## 特性

-   不使用 API 密钥而搜索 YouTube 数据
-   支持 YouTube 视频播放列表和频道上传
-   在YouTube上搜索
-   从YouTube直接播放视频

## 所需资源

节点.js `^22.22.2 || ^24.15.0 || >=26.0.0`范围 [`@distube/ytdl-core`](https://github.com/distubejs/ytdl-core) 5个支持.

## 使用量

### 插件

```ts
import { DisTube } from "distube";
import { YouTubePlugin } from "@distube/youtube";

const distube = new DisTube(client, {
  plugins: [new YouTubePlugin()],
});
```

### 搜索

```ts
import { DisTube } from "distube";
import { YouTubePlugin } from "@distube/youtube";

const youtubePlugin = new YouTubePlugin({
  cookies: [
    // ...
  ],
});

const distube = new DisTube(client, {
  plugins: [youtubePlugin],
});

const results = await distube.search("test", { type: "video", limit: 10 });
console.log(results);
```

## 文档

### YouTube 宽度

#### YouTubePlugin (\[YouTubePlugin options\]) (中文(简体) )

-   `YoutubePluginOptions.cookies`: (可选)YouTube cookie. 见: [如何获得YouTube饼干](https://github.com/skick1234/DisTube/wiki/YouTube-Cookies)
-   `YoutubePluginOptions.ytdlOptions`: (可选) [`@distube/ytdl-core` 选项](https://distube.js.org/ytdl-core/guides/getting-started/),例如 `lang`, (中文(简体) ), `clients` 或者说 `getPoToken`。 。 。 . `cookies` 替换其 `cookie`。 。 。 .

#### YouTubePlugin# search(干燥,\[可选方案\]):承诺<Song\[\]}SearchResultPlaylist\[\]

-   `query`: 搜索查询字符串
-   `options`: 搜索选项
-   `options.type`:成果类型(`video` 或者说 `playlist`(中文(简体) )
-   `options.limit`: 要返回的最大结果数
-   `options.safeSearch`:是否使用安全搜索(YouTube限制模式)

#### 搜索结果列表

-   `id`: 播放列表编号
-   `name`播放列表名称
-   `url`: 播放列表 URL
-   `length`: 播放列表中的视频数量, `0` 当YouTube没有显示时
-   `uploader`播放列表所有者
-   `uploader.name`: 播放列表所有者名称
-   `uploader.url`: 播放列表所有者 URL

## 常见问题

### @distube/youtube 是什么？

一个支持YouTube的DisTube提取器插件\.

### 如何安装 @distube/youtube？

在项目目录运行 npm install @distube/youtube，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：distube（5）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @distube/youtube 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @distube/youtube 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @distube/youtube 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js ^22\.22\.2 \|\| ^24\.15\.0 \|\| \>=26\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @distube/youtube 可以商用吗？

@distube/youtube 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @distube/youtube 的下载量有多少？

根据 npm 官方下载统计，@distube/youtube 在 2026/10/13 – 2026/11/11 这 30 天内被下载 2,249 次，日均约 75 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @distube/youtube 还在维护吗？

最新版本 1\.1\.0 发布于 2026/10/22（22 天前）；至今共发布 7 个版本，其中过去 12 个月发布了 1 个；首次发布于 2024/06/04。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。