@giphy/js-fetch-api

中文文档
5.8.0发布于 2026/05/01MITTypeScriptESM + CJS构建来源已验证近 30 天下载 110.7万

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

中文使用文档
文档目录16 节
  1. 试试看:
  2. 搜索
  3. 趋势
  4. 由 id 编辑
  5. 按标识,或类别和子类别
  6. 动画
  7. 相关
  8. 爱莫吉
  9. emoji 默认变化
  10. 情感变化
  11. 随机
  12. 类别
  13. 亚类
  14. 缓冲选项
  15. 评分选项
  16. 类型选项

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

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

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

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

获取 GIF 、 标签和动画文本

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

签署:
search(term: string, options?: SearchOptions): Promise<GifsResult>
搜索选项 :
选项类型说明默认
朗语字符串参见所支持语言列表 这里。 。 。 .内
排序编号指定结果的起始位置.近期

其他选项 : 类型选项, (中文(简体) ), 评分选项, (中文(简体) ), 缓冲选项

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

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

签署:
trending(options?: TrendingOptions): Promise<GifsResult>

趋势选项 : 类型选项, (中文(简体) ), 评分选项, (中文(简体) ), 缓冲选项

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

由 id 编辑

由 id 获取一个 gif

签署:
gif(id: string): Promise<GifResult>
示例
const { data: gif } = await gf.gif('3oEjHGr1Fhz0kyv8Ig')

按标识,或类别和子类别

签署:
// by id
gifs(ids: string[]): Promise<GifsResult>
// by category and subcategory
gifs(category: string, subcategory: string): Promise<GifsResult>
示例
// by id
const { data: gifs } = await gf.gifs(['3oEjHGr1Fhz0kyv8Ig'])
// by category and subcategory
const { data: gifs } = await gf.gifs('tv', 'arrested-development')

动画

基于文本输入创建动画文本 gifs 动态 。 这个终点需要你 创建新的 SDK 密钥

签署:
animate(text: string, options?: PaginationOptions): Promise<GifsResult>

选项 : 缓冲选项

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

基于 gif 的 ID 获取相關的 gifs

签署:
related(id: string, options?: RelatedOptions): Promise<GifsResult>

选项 : 缓冲选项, (中文(简体) ), 类型选项

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

爱莫吉

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

签署:
emoji(options?: PaginationOptions): Promise<GifsResult>

Emoji 选项 : 缓冲选项

示例
const { data: gifs } = await gf.emoji()

emoji 默认变化

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

签署:
emojiDefaultVariations(options?: PaginationOptions): Promise<GifsResult>

选项 : 缓冲选项

示例
const { data: gifs } = await gf.emojiDefaultVariations()

情感变化

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

签署:
emojiVariations(id: GifID): Promise<NonPaginatedGifsResult>
示例
const { data: gifs } = await gf.emojiVariations('iigp4VDyf5dCLRlGkm')

随机

返回随机单个 GIF

签署:
random(options?: RandomOptions): Promise<GifResult>
随机选项 :
选项类型说明默认
标签字符串GIF 标记以限制随机性 .未定义

选项 : 类型选项

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

获取类别和子类别

类别

categories(options?: CategoriesOptions): Promise<CategoriesResult>
const { data: categories } = await gf.categories()
categories.forEach((category) => {
    console.log(category) // ICategory
})

选项 : 缓冲选项

亚类

subcategories(category: string, options?: SubcategoriesOptions): Promise<CategoriesResult>
// Example:
const { data: categories } = await gf.subcategories('tv', { limit: 10, offset: 25, rating: 'g' })
categories.forEach((category) => {
    console.log(category) // ICategory
})

选项 : 缓冲选项

共享选项

缓冲选项

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

评分选项

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

类型选项

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

版本与发布记录

@giphy/js-fetch-api 共发布 92 个版本,首次发布于 2019/03/27;过去 12 个月发布了 1 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
5.8.0latest2026/05/016 个月前
5.7.02025/07/091.4 年前
0.0.0-hidden-gifs-20250701132558hidden-gifs2025/07/011.4 年前
0.0.0-hidden-gifs-202506302035092025/07/011.4 年前
0.0.0-hidden-gifs-202506301954452025/07/011.4 年前
0.0.0-hidden-gifs-202506261950552025/06/271.4 年前

其他发布通道:canary → 0.0.0-canary-20230621031504,beta → 5.5.0-beta.1,charlie → 5.5.0-charlie.0,moat-testing → 0.0.0-moat-testing-20240502211419,hidden-gifs → 0.0.0-hidden-gifs-20250701132558。

关于 @giphy/js-fetch-api 的常见问题

@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 和提交记录判断。