npm 包 zot 使用教程

前言

在前端开发中，我们经常需要处理文献引用。而 Zotero 作为一款免费开源的文献引用管理工具，支持 Firefox、Chrome、Safari 等多个浏览器插件，允许你方便地进行文献的收集、整理和引用。在前端开发中，使用 Zotero 的 API 提供的检索及查询服务也是一个不错的选择。在本文中，我将介绍使用 npm 包 zot 能够实现的功能及其使用方法。

zot

zot 是一个专门针对 Zotero API 所开发的 npm 包，侧重于对 Zotero 内的文献管理进行操作。使用该包，你可以很方便地从 Zotero 内获取文献，并在你的前端项目中使用。

安装

你可以通过 npm 安装该包，请在终端中输入以下命令：

npm install zot

安装完成后，你需要获取 API 密钥，以启用对 Zotero API 的访问。API 密钥可以通过下面的步骤来获取：

• 在 Zotero 的网站上注册账号，并下载安装浏览器插件；
• 在插件中生成 API 密钥。

当你获得 API 密钥后，使用以下方式配置 zot：

import Zotero from "zot";
const zotero = new Zotero("YOUR API KEY");

如何使用

检索文献

使用关键词检索文献：

const items = await zotero.search({
  q: "JavaScript",
});
console.log(items);

获取文献

根据文献 ID 获取文献：

const item = await zotero.getItem("ITEM ID");
console.log(item);

添加文献

添加简单文献类型：

const newItem = await zotero.createItem("book");
newItem.set("title", "zot usage");
console.log(newItem);

添加带子字段的文献类型：

const newItem = await zotero.createItem("journalArticle");
newItem.set("title", "zot usage");
newItem.set("creators", [
  {
    firstName: "John",
    lastName: "Smith",
    creatorType: "author",
  },
]);
console.log(newItem);

修改文献

修改文献元数据：

const item = await zotero.getItem("ITEM ID");
item.set("title", "New Title");
console.log(item);

删除文献

根据文献 ID 删除文献：

await zotero.deleteItem("ITEM ID");

总结

本文详细介绍了 npm 包 zot 提供的能力及其使用方法。使用该包，你可以很方便地与 Zotero API 进行交互，并在你的前端项目中使用文献数据。如果你需要更多的功能支持，建议查阅 zot 的文档，以便更加深入地了解该包。

来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/600673dffb81d47349e53c49