From dbafe75039bd34de1059e49f7a9ddb8a5bf84ed4 Mon Sep 17 00:00:00 2001 From: saqqdy Date: Thu, 18 Feb 2021 20:13:23 +0800 Subject: [PATCH] download & searchTreeObject --- API.md | 57 ----------------------------------------- README.md | 57 ----------------------------------------- src/addEvent.js | 2 ++ src/cutCHSString.js | 1 + src/download.js | 1 + src/searchTreeObject.js | 1 + 6 files changed, 5 insertions(+), 114 deletions(-) diff --git a/API.md b/API.md index 99a17e69..9ad1d8cd 100644 --- a/API.md +++ b/API.md @@ -4,12 +4,6 @@
addEvent(element, type, handler)

addEvent()事件委托，支持多次委托

-
handleEvent(event) ⇒ Boolean
-

handleEvent()执行事件

-
-
fixEvent(event) ⇒ Object
-

为IE的事件对象添加一些“缺失的”函数

-
camel2Dash(string) ⇒ String

camel2Dash 将驼峰字符串转成-间隔且全小写的Dash模式

@@ -79,9 +73,6 @@ name*exMall-detail-goodsInfoId!params(goodsInfoId)*8866 转成 name=exMall-detai
download(url, filename, type)

文件下载的几种方式：1. 针对一些浏览器无法识别的文件格式。地址栏输入文件URL、window.location.href = URL、window.open(URL)；2. 使用a标签download属性（或者js创建a标签）；3. 浏览器可识别的pdf、txt文件，后端兼容处理attachment；4. 在header增加token用于鉴权下载，使用XmlHttpRequest来想后台发起请求

-
saveFile(data, filename)
-

保存文件

-
encodeBase64(input) ⇒ String

字符串、数字转base64

@@ -235,29 +226,6 @@ addEvent()事件委托，支持多次委托 | type | String | 事件类型。不需要加on | | handler | function | 回调方法 | - - -## handleEvent(event) ⇒ Boolean -handleEvent()执行事件 - -**Kind**: global function - -| Param | Type | Description | -| ----- | ------------------- | ----------- | -| event | String | 事件类型 | - - - -## fixEvent(event) ⇒ Object -为IE的事件对象添加一些“缺失的”函数 - -**Kind**: global function -**Returns**: Object - 返回补齐了缺失方法的的event - -| Param | Type | Description | -| ----- | ------------------- | ----------- | -| event | String | 事件类型 | - ## camel2Dash(string) ⇒ String @@ -521,18 +489,6 @@ name*exMall-detail-goodsInfoId!params(goodsInfoId)*8866 转成 name=exMall-detai | filename | String | | 文件名 | | type | String | download | 下载类型 'href','open','download','request' | - - -## saveFile(data, filename) -保存文件 - -**Kind**: global function - -| Param | Type | Description | -| -------- | ------------------- | ----------- | -| data | Object | 文件数据 | -| filename | String | 文件名 | - ## encodeBase64(input) ⇒ String @@ -958,19 +914,6 @@ tree对象深度查找 | keySet | object | 选填 默认的子类名称、查询name | | number | number | 选填 查找个数，不传则查询全部 | - - -### searchTreeObject~deepSearch([Object, Array], expression) ⇒ Object -递归查找 - -**Kind**: inner method of [searchTreeObject](#searchTreeObject) -**Returns**: Object - Nodes - -| Param | Type | Description | -| --------------- | ------------------- | ----------- | -| [Object, Array] | | tree 对象 | -| expression | String | 表达式 | - ## setCache(name, value, seconds) ⇒ diff --git a/README.md b/README.md index 092cd739..0151a9d7 100755 --- a/README.md +++ b/README.md @@ -204,12 +204,6 @@ searchTreeObject, // 对象查找
addEvent(element, type, handler)

addEvent()事件委托，支持多次委托

-
handleEvent(event) ⇒ Boolean
-

handleEvent()执行事件

-
-
fixEvent(event) ⇒ Object
-

为IE的事件对象添加一些“缺失的”函数

-
camel2Dash(string) ⇒ String

camel2Dash 将驼峰字符串转成-间隔且全小写的Dash模式

@@ -279,9 +273,6 @@ name*exMall-detail-goodsInfoId!params(goodsInfoId)*8866 转成 name=exMall-detai
download(url, filename, type)

文件下载的几种方式：1. 针对一些浏览器无法识别的文件格式。地址栏输入文件URL、window.location.href = URL、window.open(URL)；2. 使用a标签download属性（或者js创建a标签）；3. 浏览器可识别的pdf、txt文件，后端兼容处理attachment；4. 在header增加token用于鉴权下载，使用XmlHttpRequest来想后台发起请求

-
saveFile(data, filename)
-

保存文件

-
encodeBase64(input) ⇒ String

字符串、数字转base64

@@ -435,29 +426,6 @@ addEvent()事件委托，支持多次委托 | type | String | 事件类型。不需要加on | | handler | function | 回调方法 | - - -## handleEvent(event) ⇒ Boolean -handleEvent()执行事件 - -**Kind**: global function - -| Param | Type | Description | -| ----- | ------------------- | ----------- | -| event | String | 事件类型 | - - - -## fixEvent(event) ⇒ Object -为IE的事件对象添加一些“缺失的”函数 - -**Kind**: global function -**Returns**: Object - 返回补齐了缺失方法的的event - -| Param | Type | Description | -| ----- | ------------------- | ----------- | -| event | String | 事件类型 | - ## camel2Dash(string) ⇒ String @@ -721,18 +689,6 @@ name*exMall-detail-goodsInfoId!params(goodsInfoId)*8866 转成 name=exMall-detai | filename | String | | 文件名 | | type | String | download | 下载类型 'href','open','download','request' | - - -## saveFile(data, filename) -保存文件 - -**Kind**: global function - -| Param | Type | Description | -| -------- | ------------------- | ----------- | -| data | Object | 文件数据 | -| filename | String | 文件名 | - ## encodeBase64(input) ⇒ String @@ -1158,19 +1114,6 @@ tree对象深度查找 | keySet | object | 选填 默认的子类名称、查询name | | number | number | 选填 查找个数，不传则查询全部 | - - -### searchTreeObject~deepSearch([Object, Array], expression) ⇒ Object -递归查找 - -**Kind**: inner method of [searchTreeObject](#searchTreeObject) -**Returns**: Object - Nodes - -| Param | Type | Description | -| --------------- | ------------------- | ----------- | -| [Object, Array] | | tree 对象 | -| expression | String | 表达式 | - ## setCache(name, value, seconds) ⇒ diff --git a/src/addEvent.js b/src/addEvent.js index 14846d5d..9ffd869d 100644 --- a/src/addEvent.js +++ b/src/addEvent.js @@ -33,6 +33,7 @@ addEvent.guid = 1 /** * handleEvent()执行事件 * + * @private * @param {String} event 事件类型 * @returns {Boolean} */ @@ -54,6 +55,7 @@ function handleEvent(event) { /** * 为IE的事件对象添加一些“缺失的”函数 + * @private * @param {String} event 事件类型 * @returns {Object} 返回补齐了缺失方法的的event */ diff --git a/src/cutCHSString.js b/src/cutCHSString.js index 6985be3e..28aa19db 100644 --- a/src/cutCHSString.js +++ b/src/cutCHSString.js @@ -1,5 +1,6 @@ /** * js截取字符串，中英文都能用 + * @private * @param str：需要截取的字符串 * @param len: 需要截取的长度 */ diff --git a/src/download.js b/src/download.js index 800246fe..76c7a7eb 100644 --- a/src/download.js +++ b/src/download.js @@ -55,6 +55,7 @@ function downloadUrlFile(url, filename) { /** * @description 保存文件 + * @private * @param {Object} data 文件数据 * @param {String} filename 文件名 */ diff --git a/src/searchTreeObject.js b/src/searchTreeObject.js index a71d051a..dcf40930 100644 --- a/src/searchTreeObject.js +++ b/src/searchTreeObject.js @@ -17,6 +17,7 @@ function searchTreeObject(tree, expression, keySet, number = null) { keySet = { childName: 'child', keyName: 'name', ...keySet } /** * @description 递归查找 + * @private * @param [Object, Array] tree 对象 * @param {String} expression 表达式 * @returns {Object} Nodes