1.0.2 • Published 2 years ago

wx_pushplus v1.0.2

Weekly downloads
-
License
ISC
Repository
-
Last release
2 years ago

Description

为pushplus写的nodejs库,轻量简洁,易于使用,专注于通知这一功能。 使用前请登录官网获取token(key)。

官网地址:https://www.pushplus.plus/

Usage

Example

//在nodejs中导入此库并初始化
var Push = require("wx_pushplus")
var push = new Push(key)
push.send("send()", "local time: " + new Date(), true)

Api

Push(arg)

推送类,使用前需初始化,有两种初始化方式。

第一种,若只需传入key(token),则直接传入即可(见上方示例)

第二种,传入arg配置对象。 如var push=new Push({key: "", }),以下介绍配置选项。

  • key 必需,也称token。请到官网获取,并妥善保管,勿泄露
  • text 可选,默认通知标题
  • desp 可选,默认通知内容
  • retries 可选,发送失败后默认重试次数,默认为3
  • 其他请求参数,可选,仅供需要者使用,见官网HTTP POST请求参数

.send(text, desc, isPlain=false)

发送推送通知,若发送失败则抛出错误,失败后不重试。

  • text:必需,为通知标题(title/head)
  • desc:可选,为通知内容(content/body)
  • isPlain:可选,参数定义传入内容是否为纯文本,若不是则当markdown处理(提示:MD换行需用"\n\n")。

.sendSilently(text, desc, isPlain)

静默发送推送通知,若发送成功返回true,若失败,则返回错误对象error,不抛出错误。

  • 参数同上。

.sendWithRetry(text, desc, isPlain, retries)

  • retries:可选,失败后重试次数,若最后一次重试后仍失败则抛出错误。若不传此参数,则使用类初始化时定义的默认值。
  • 其他参数同上。

Feedback

如发现bug,可通过以下链接反馈,并备注此库名称: https://support.qq.com/product/367583

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago