# @giphy/js-fetch-api 中文文档

规范地址：https://npmcn.com/package/%40giphy/js-fetch-api/

版本：5\.8\.0
npm 元数据更新时间：2026-05-01T15:14:07.135Z
中文译文更新时间：2026-11-16T09:20:03.072Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40giphy/js-fetch-api
原文对照：https://npmcn.com/package/%40giphy/js-fetch-api/?lang=original
项目主页：https://github.com/Giphy/giphy-js/tree/master/packages/fetch-api
源码仓库：https://github.com/Giphy/giphy-js

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

- 包体积（解压后）：78.1 kB，17 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2019-03-26T20:55:31.272Z
- 最新版本发布：2026-05-01T15:14:06.896Z
- 近 30 天下载量：1107222（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：92（近 12 个月 1 个）

## 中文简介

Javascript API 从 GIPHY API 取出 gifs 和标签 .

## 安装

```sh
npm install @giphy/js-fetch-api
```

也可以使用：`pnpm add @giphy/js-fetch-api`、`yarn add @giphy/js-fetch-api`、`bun add @giphy/js-fetch-api`

## README

# @giphy/js-fetch-api (英语)

Javascript API 从 GIPHY API 取出 gifs 和标签 .

用您自己的 api 键开始 : [https://developers.giphy.com/docs/ 页面存档备份,存于互联网档案馆](https://developers.giphy.com/docs/)

```typescript
import { GiphyFetch } from '@giphy/js-fetch-api'

const gf = new GiphyFetch('your api key')

// fetch 10 gifs
const { data: gifs } = await gf.trending({ limit: 10 })
```

## 试试看:

[![Edit @giphy/js-fetch-api](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/20kmp3zp9r?fontsize=14)

# 获取 GIF 、 标签和动画文本

## _搜索_

搜索所有 Giphy GIFs 的单词或短语 。 平按:"灵枢"作平取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取.

##### 签署:

```typescript
search(term: string, options?: SearchOptions): Promise<GifsResult>
```

##### 搜索选项 :

| 选项 | 类型 | 说明 | 默认 |
| :-- | :-- | :-- | :-: |
| _朗语_ | 字符串 | 参见所支持语言列表 [这里](https://developers.giphy.com/docs/#language-support)。 。 。 . | 内 |
| _排序_ | 编号 | 指定结果的起始位置. | 近期 |

> 其他选项 : [类型选项](https://npmcn.com/package/%40giphy/js-fetch-api/#readme-type-option), (中文(简体) ), [评分选项](https://npmcn.com/package/%40giphy/js-fetch-api/#readme-rating-option), (中文(简体) ), [缓冲选项](https://npmcn.com/package/%40giphy/js-fetch-api/#readme-pagination-options)

##### 示例

```typescript
const { data: gifs } = await gf.search('dogs', { sort: 'relevant', lang: 'es', limit: 10, type: 'stickers' })
```

## _趋势_

获取当前在线GIFs 趋势 。 由吉菲编辑组主持. 数据还原镜像了Giphy主页上显示的GIFs.

##### 签署:

```typescript
trending(options?: TrendingOptions): Promise<GifsResult>
```

> 趋势选项 : [类型选项](https://npmcn.com/package/%40giphy/js-fetch-api/#readme-type-option), (中文(简体) ), [评分选项](https://npmcn.com/package/%40giphy/js-fetch-api/#readme-rating-option), (中文(简体) ), [缓冲选项](https://npmcn.com/package/%40giphy/js-fetch-api/#readme-pagination-options)

##### 示例

```typescript
const { data: gifs } = await gf.trending({ limit: 10, offset: 25, rating: 'g' })
```

## _由 id 编辑_

由 id 获取一个 gif

##### 签署:

```typescript
gif(id: string): Promise<GifResult>
```

##### 示例

```typescript
const { data: gif } = await gf.gif('3oEjHGr1Fhz0kyv8Ig')
```

## _按标识,或类别和子类别_

##### 签署:

```typescript
// by id
gifs(ids: string[]): Promise<GifsResult>
// by category and subcategory
gifs(category: string, subcategory: string): Promise<GifsResult>
```

##### 示例

```typescript
// by id
const { data: gifs } = await gf.gifs(['3oEjHGr1Fhz0kyv8Ig'])
// by category and subcategory
const { data: gifs } = await gf.gifs('tv', 'arrested-development')
```

## _动画_

基于文本输入创建动画文本 gifs 动态 。 这个终点需要你 [创建新的 SDK 密钥](https://developers.giphy.com/dashboard/)

##### 签署:

```typescript
animate(text: string, options?: PaginationOptions): Promise<GifsResult>
```

> 选项 : [缓冲选项](https://npmcn.com/package/%40giphy/js-fetch-api/#readme-pagination-options)

##### 示例

```typescript
const { data: gifs } = await gf.animate('some text to animate!', { limit: 5 })
```

## _相关_

基于 gif 的 ID 获取相關的 gifs

##### 签署:

```typescript
related(id: string, options?: RelatedOptions): Promise<GifsResult>
```

> 选项 : [缓冲选项](https://npmcn.com/package/%40giphy/js-fetch-api/#readme-pagination-options), (中文(简体) ), [类型选项](https://npmcn.com/package/%40giphy/js-fetch-api/#readme-type-option)

##### 示例

```typescript
const { data: gifs } = await gf.related('3oEjHGr1Fhz0kyv8Ig', { limit: 10 })
```

## _爱莫吉_

去找爱莫吉 爱莫吉是来自曲艺频道的贴纸 没有搜索或趋势 emoji.

##### 签署:

```typescript
emoji(options?: PaginationOptions): Promise<GifsResult>
```

> Emoji 选项 : [缓冲选项](https://npmcn.com/package/%40giphy/js-fetch-api/#readme-pagination-options)

##### 示例

```typescript
const { data: gifs } = await gf.emoji()
```

## _emoji 默认变化_

返回所有默认的 emoji 变换的列表 .

##### 签署:

```typescript
emojiDefaultVariations(options?: PaginationOptions): Promise<GifsResult>
```

> 选项 : [缓冲选项](https://npmcn.com/package/%40giphy/js-fetch-api/#readme-pagination-options)

##### 示例

```typescript
const { data: gifs } = await gf.emojiDefaultVariations()
```

## _情感变化_

返回一个代表 emoji 的所有变量的 gifs 列表.

##### 签署:

```typescript
emojiVariations(id: GifID): Promise<NonPaginatedGifsResult>
```

##### 示例

```typescript
const { data: gifs } = await gf.emojiVariations('iigp4VDyf5dCLRlGkm')
```

## _随机_

返回随机单个 GIF

##### 签署:

```typescript
random(options?: RandomOptions): Promise<GifResult>
```

##### 随机选项 :

| 选项 | 类型 | 说明 | 默认 |
| :-- | :-- | :-- | :-: |
| _标签_ | 字符串 | GIF 标记以限制随机性 . | 未定义 |

> 选项 : [类型选项](https://npmcn.com/package/%40giphy/js-fetch-api/#readme-type-option)

##### 示例

```typescript
const { data: gif } = await gf.random({ tag: 'beer', type: 'stickers' })
```

# 获取类别和子类别

## _类别_

```typescript
categories(options?: CategoriesOptions): Promise<CategoriesResult>
```

```typescript
const { data: categories } = await gf.categories()
categories.forEach((category) => {
    console.log(category) // ICategory
})
```

选项 : [缓冲选项](https://npmcn.com/package/%40giphy/js-fetch-api/#readme-pagination-options)

## _亚类_

```typescript
subcategories(category: string, options?: SubcategoriesOptions): Promise<CategoriesResult>
```

```typescript
// Example:
const { data: categories } = await gf.subcategories('tv', { limit: 10, offset: 25, rating: 'g' })
categories.forEach((category) => {
    console.log(category) // ICategory
})
```

选项 : [缓冲选项](https://npmcn.com/package/%40giphy/js-fetch-api/#readme-pagination-options)

# 共享选项

### 缓冲选项

| 选项 | 类型 | 说明 | 默认 |
| :-- | :-- | :-- | :-: |
| _限制_ | 编号 | 最多返回100个结果数目 | 第25条 |
| _页:1_ | 编号 | 指定结果的起始位置. | 0 个 |

### 评分选项

| 选项 | 类型 | 说明 | 默认 |
| :-- | :-- | :-- | :-: |
| _评级_ | 字符串 | 通过评级限制结果 : _y, g, pg, pg-13, pg-13, r (英语)_。 。 。 . | 页:1 |

### 类型选项

| 选项 | 类型 | 说明 | 默认 |
| :-- | :-- | :-- | :-: |
| _类型_ | 字符串 | gifs / 标签 / 文本 / 视频 | 数字 |

## 常见问题

### @giphy/js-fetch-api 是什么？

Javascript API 从 GIPHY API 取出 gifs 和标签 \.

### 如何安装 @giphy/js-fetch-api？

在项目目录运行 npm install @giphy/js-fetch-api，或使用 pnpm add / yarn add / bun add。

### @giphy/js-fetch-api 支持 TypeScript 吗？

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

### @giphy/js-fetch-api 支持 ESM 还是 CommonJS？

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

### @giphy/js-fetch-api 可以商用吗？

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

### @giphy/js-fetch-api 的下载量有多少？

根据 npm 官方下载统计，@giphy/js-fetch-api 在 2026/10/17 – 2026/11/15 这 30 天内被下载 1,107,222 次，日均约 36,907 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @giphy/js-fetch-api 还在维护吗？

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

