npm 包 @jc21/radarr-api 使用教程

阅读时长 4 分钟读完

前言

@jc21/radarr-api 是一个基于 Node.js 的 npm 包,它提供了与 Radarr API 的交互封装,可用于从 Node.js 应用程序中管理 Radarr(一个电影自动化下载程序)。本文将介绍如何使用 @jc21/radarr-api 包的详细步骤,读者需要具有一定的 Node.js 基础知识。

安装

在开始使用 @jc21/radarr-api 包之前,我们要先安装它,可以使用下述命令进行全局安装:

也可以在局部安装,在项目的根目录下使用下述命令:

使用

连接 Radarr API

首先需要在你的应用程序中连接 Radarr API,可通过如下代码:

其中,hostname 为 Radarr 的域名或 IP 地址,port 为 Radarr 所运行的端口(默认为 7878),apiKey 为 Radarr API 的密钥(在 Radarr 界面上获取)。

获取电影信息

-- -------------------- ---- -------
------------------------
  ------------- -- -
    ------------------ --- --------------
    ------------------ ------ -----------------
    ------------------ ----- ----------------
  --
  -------------- -- -
    -------------------- ------- ----- ------------ -----------
  ---

以上代码中的 getMovie 方法将返回指定电影的详细信息,movieId 为电影 ID。

添加电影

以上代码中的 addMovie 方法将会向 Radarr 添加一部电影,movieName 为电影名称,path 为电影保存的本地路径。

更新电影

以上代码中的 updateMovie 方法更新 Radarr 中指定 ID 的电影信息。

删除电影

以上代码中的 deleteMovie 方法将从 Radarr 中删除指定 ID 的电影。

总结

在本文中,我们介绍了如何使用 @jc21/radarr-api 包与 Radarr API 进行交互,通过学习本文,读者可以学会如何连接 Radarr API,获取、添加、更新和删除电影信息,该 npm 包可以方便地集成到您的 Node.js 应用程序中,为您的开发工作带来便利。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60067357890c4f7277583cfa

纠错
反馈