npm 包 extension-cnode 使用教程

介绍

extension-cnode 是一个帮助开发 cnode 社区网站的前端开发者更高效的使用 cnode API 的 npm 包。它提供了一些常用的 API 接口，例如获取所有主题，获取主题详情和评论等，并且还提供了一些便于前端开发的工具函数。

本篇文章将教导读者如何使用 extension-cnode。

安装

使用 npm 可以很方便的安装 extension-cnode。

npm install extension-cnode

使用

在使用 extension-cnode 之前，你需要拥有 cnode 社区的 API Access Token。关于如何获取 API Access Token 的教程，请参考 cnode 社区。

安装完成后，你需要在你的项目中引入 extension-cnode：

const CnodeClient = require('extension-cnode')

const api = new CnodeClient({
  accessToken: 'your_access_token'
})

获取主题

使用 api.getTopics({page: Number, limit: Number, tab: String, mdrender: Boolean}) 可以获取主题列表。

api.getTopics({page: 1, limit: 10}).then((res) => {
  console.log(res)
}).catch((err) => {
  console.log(err)
})

获取主题详情

使用 api.getTopicById(id: String, mdrender: Boolean) 可以通过主题 ID 获取主题详情。

api.getTopicById('5deb655e3b63a66b8fc971d5', true).then((res) => {
  console.log(res)
}).catch((err) => {
  console.log(err)
})

获取评论

使用 api.getCommentsByTopicId(id: String, mdrender: Boolean) 可以通过主题 ID 获取主题的评论。

api.getCommentsByTopicId('5deb655e3b63a66b8fc971d5', true).then((res) => {
  console.log(res)
}).catch((err) => {
  console.log(err)
})

工具函数

extension-cnode 还提供了一些便于前端开发的工具函数，例如将 markdown 格式的文本转换成 HTML 格式的函数 api.renderMarkdown(text: String) 和将时间转换成特定格式的函数 api.formatTime(date: Date)。

api.renderMarkdown('# Hello World!').then((res) => {
  console.log(res)
}).catch((err) => {
  console.log(err)
})

console.log(api.formatTime(new Date()))

结语

通过本篇文章，我们学习了如何使用 npm 包 extension-cnode，并且了解了其中提供的 API 接口和工具函数。期望读者能够通过这篇文章更高效的开发 cnode 社区网站。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005587481e8991b448d5af0