➕ eslint-plugin-jsdoc

lib/puppeteer/puppeteer.js

@@ -27,17 +27,16 @@ class NewPuppeteer {
 
   /**
    * 截取网页截图
-   *
    * @async
-   * @param {Object} options - 参数选项对象
+   * @param {object} options - 参数选项对象
    * @param {string} options.url - 网页URL地址
-   * @param {Object|false} [options.headers=false] - 请求头信息
-   * @param {Object|false} [options.setViewport=false] - 设置浏览器视窗大小
-   * @param {boolean} [options.font=false] - 是否设置字体样式
-   * @param {Object|false} [options.cookie=false] - 设置cookie信息
-   * @param {boolean} [options.fullPage=true] - 是否截取整个网页
-   * @param {string|boolean} [options.emulate=false] - 模拟设备信息
-   * @param {Array|false} [options.click=false] - 点击事件
+   * @param {object | false} [options.headers] - 请求头信息
+   * @param {object | false} [options.setViewport] - 设置浏览器视窗大小
+   * @param {boolean} [options.font] - 是否设置字体样式
+   * @param {object | false} [options.cookie] - 设置cookie信息
+   * @param {boolean} [options.fullPage] - 是否截取整个网页
+   * @param {string|boolean} [options.emulate] - 模拟设备信息
+   * @param {Array|false} [options.click] - 点击事件
    * @returns {Promise<import('icqq').segment.image>} Promise对象，如果截图成功返回构造图片消息，否则返回false
    */
   async Webpage ({
@@ -157,7 +156,7 @@ class NewPuppeteer {
    * @async
    * @param {string} url - 要跳转的 URL。
    * @param {string} waitSelector - 等待页面渲染的选择器。
-   * @returns {Object} - 包含 URL 和页面数据的对象。
+   * @returns {object} - 包含 URL 和页面数据的对象。
    * @throws 如果导航或页面数据检索失败，将抛出错误。
    */
   async get (url, waitSelector) {

lib/puppeteer/render.js

@@ -5,11 +5,11 @@ const _path = process.cwd()
 
 export default new class {
 /**
-   * @description: 渲染HTML
-   * @param {String} path 文件路径
-   * @param {Object} params 参数
-   * @param {Object} cfg
-   */
+ * 渲染HTML
+ * @param {string} path 文件路径
+ * @param {object} params 参数
+ * @param {object} cfg
+ */
   async render (path, params, cfg) {
     let [app, tpl] = path.split('/')
     let { e } = cfg

lib/request/request.js

@@ -35,10 +35,10 @@ export default new class {
    * @async
    * @function
    * @param {string} url - 请求的URL
-   * @param {Object} [options={}] - 请求的配置项
-   * @param {Object} [options.params] - 请求的参数
-   * @param {Object} [options.headers] - 请求的HTTP头部
-   * @param {boolean} [options.closeCheckStatus=false] - 是否关闭状态检查
+   * @param {object} [options] - 请求的配置项
+   * @param {object} [options.params] - 请求的参数
+   * @param {object} [options.headers] - 请求的HTTP头部
+   * @param {boolean} [options.closeCheckStatus] - 是否关闭状态检查
    * @param {'buffer'|'json'|'text'|'arrayBuffer'|'formData'|'blob'}[options.statusCode] - 期望的返回数据，如果设置了该值，则返回响应数据的特定的方法（如json()、text()等）
    * @returns {Promise<Response|*>} - HTTP响应或响应数据
    * @throws {Error} - 如果请求失败，则抛出错误
@@ -76,11 +76,11 @@ export default new class {
    * @async
    * @function
    * @param {string} url - 请求的URL
-   * @param {object} [options={}] - 请求的配置项
+   * @param {object} [options] - 请求的配置项
    * @param {object} [options.params] - 请求的参数
    * @param {object} [options.headers] - 请求的HTTP头部
    * @param {object} [options.data] - 请求的数据
-   * @param {boolean} [options.closeCheckStatus=false] - 是否关闭状态检查
+   * @param {boolean} [options.closeCheckStatus] - 是否关闭状态检查
    * @param {'buffer'|'json'|'text'|'arrayBuffer'|'formData'|'blob'} [options.statusCode] - 期望的返回数据，如果设置了该值，则返回响应数据的特定的方法（如json()、text()等）
    * @returns {Promise<Response|*>} - HTTP响应或响应数据
    * @throws {Error} - 如果请求失败，则抛出错误
@@ -127,11 +127,11 @@ export default new class {
   }
 
   /**
-   * @description: 绕cf Get请求
-   * @param {String} url
-   * @param {Object} options 同fetch第二参数
-   * @param {Object} options.params 请求参数
-   * @return {FetchObject}
+   * 绕cf Get请求
+   * @param {string} url
+   * @param {object} options 同fetch第二参数
+   * @param {object} options.params 请求参数
+   * @returns {Promise<Response|*>}
    */
   async cfGet (url, options = {}) {
     options.agent = this.getAgent(true)
@@ -143,11 +143,11 @@ export default new class {
   }
 
   /**
-   * @description: 绕cf Post请求
-   * @param {String} url
-   * @param {Object} options 同fetch第二参数
-   * @param {Object|String} options.data 请求参数
-   * @return {FetchObject}
+   * 绕cf Post请求
+   * @param {string} url
+   * @param {object} options 同fetch第二参数
+   * @param {object | string} options.data 请求参数
+   * @returns {Promise<Response|*>}
    */
   async cfPost (url, options = {}) {
     options.agent = this.getAgent(true)
@@ -198,12 +198,13 @@ export default new class {
   }
 
   /**
-   * @description: 代理请求图片
-   * @param {String} url 图片链接
-   * @param {Boolean} cache 是否缓存
-   * @param {Number} timeout 超时时间
-   * @param {Object} headers 请求头
-   * @return {Porimes<import('icqq').ImageElem>} 构造图片消息
+   * 代理请求图片
+   * @param {string} url 图片链接
+   * @param {object} options 配置
+   * @param {boolean} options.cache 是否缓存
+   * @param {number} options.timeout 超时时间
+   * @param {object} options.headers 请求头
+   * @returns {Promise<import('icqq').ImageElem>} 构造图片消息
    */
   async proxyRequestImg (url, { cache, timeout, headers } = {}) {
     if (!this.getAgent()) return segment.image(url, cache, timeout, headers)