Trello-state 是一个基于 trello API 的 npm 包,它可以让你方便地获取 trello 中的卡片信息,并实时监控卡片状态的变化。本文将介绍 trello-state 的使用方法,包括安装、配置以及相关 API 的使用。
安装
在终端中执行以下命令进行安装:
npm install trello-state --save
配置
在使用 trello-state 之前,我们需要先进行配置。首先,需要在 trello 开发者中心 中获取你的 API Key 和 Token。在获取 API Key 后,还需要通过访问以下链接来获取 Token:
https://trello.com/1/connect?key=API_KEY&name=trello-state&response_type=token&scope=read,write
其中 API_KEY
是你申请的 API Key。在访问链接后,trello 会要求你进行授权,同意后会返回一个 Token。将 Token 和 API Key 保存至一个 .env
文件中,以便后续调用。
TRELLO_API_KEY=<your_api_key> TRELLO_TOKEN=<your_token>
使用
在你的应用程序中引入 trello-state,并创建一个新的实例:
const TrelloState = require('trello-state') const trelloState = new TrelloState({ apiKey: process.env.TRELLO_API_KEY, token: process.env.TRELLO_TOKEN, })
接下来,就可以使用 trello-state 提供的 API 来处理 trello 中的卡片了。
获取卡片信息
获取单个卡片信息:
const card = await trelloState.getCard('card_id') console.log(card)
获取指定列表下的所有卡片信息:
const cards = await trelloState.getCards('list_id') console.log(cards)
监听卡片状态变化
使用 watch()
方法可以对特定卡片进行实时监控,当卡片状态发生变化时会触发回调函数。
const callback = (card) => { console.log(`Card ${card.id} has been updated`) } trelloState.watch('card_id', callback)
更新卡片状态
使用 updateCard()
方法可以更新卡片的状态。
const updateData = { name: 'New Card Name', desc: 'Card Description', } const card = await trelloState.updateCard('card_id', updateData) console.log(card)
总结
本文介绍了 npm 包 trello-state 的使用方法,包括安装、配置和相关 API 的使用。trello-state 为前端开发者提供了一个轻量级的解决方案,用于在应用程序中获取及实时监控 trello 中卡片的变化。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005538d81e8991b448d0bca