feat(wxrobot): 增加tsdoc

novlan1 · Apr 7, 2022 · 476a61e · 476a61e
1 parent 5f667fa
commit 476a61e
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/src/wecom-robot/helper.ts b/src/wecom-robot/helper.ts
@@ -1,5 +1,11 @@
 const axios = require('axios')
 
+/**
+ * 给机器人发消息的基本方法
+ *
+ * @param config - 包含webhookUrl, params
+ * @returns
+ */
 export function sendToRobot({ webhookUrl, params }): any {
   return new Promise((resolve, reject) => {
     if (!webhookUrl) {

diff --git a/src/wecom-robot/index.ts b/src/wecom-robot/index.ts
@@ -1,5 +1,10 @@
 import { sendToRobot } from './helper'
 
+/**
+ * 给机器人发送普通消息
+ * @param config - { webhookUrl, chatId, alias, content }
+ * @returns
+ */
 export function sendWxRobotMsg({ webhookUrl, chatId, alias, content }) {
   return new Promise((resolve, reject) => {
     sendToRobot({
@@ -22,6 +27,11 @@ export function sendWxRobotMsg({ webhookUrl, chatId, alias, content }) {
   })
 }
 
+/**
+ * 给机器人发送Markdown消息
+ * @param config - { webhookUrl, chatId, content, attachments }
+ * @returns
+ */
 export function sendWxRobotMarkdown({
   webhookUrl,
   chatId,
@@ -50,6 +60,11 @@ export function sendWxRobotMarkdown({
   })
 }
 
+/**
+ * 给机器人发送图片
+ * @param config - { webhookUrl, chatId, content, md5Val }
+ * @returns
+ */
 export async function sendWxRobotImg({ webhookUrl, chatId, content, md5Val }) {
   return new Promise((resolve, reject) => {
     sendToRobot({