├── .editorconfig ├── .eslintignore ├── .eslintrc.js ├── .github └── workflows │ └── node.js.yml ├── .gitignore ├── .prettierignore ├── .prettierrc.js ├── LICENSE ├── README.md ├── _docs.build.js ├── _docs.custom.css ├── _docs.onload.js ├── demo └── test.js ├── dev.build.js ├── dev.config.js ├── dev.md ├── dist ├── Array │ ├── index.d.ts │ └── index.d.ts.map ├── Cookies │ ├── index.d.ts │ └── index.d.ts.map ├── Crypto │ ├── index.d.ts │ └── index.d.ts.map ├── Data │ ├── index.d.ts │ └── index.d.ts.map ├── Date │ ├── index.d.ts │ └── index.d.ts.map ├── Dev │ ├── index.d.ts │ └── index.d.ts.map ├── Dom │ ├── index.d.ts │ └── index.d.ts.map ├── File │ ├── index.d.ts │ └── index.d.ts.map ├── Form │ ├── index.d.ts │ └── index.d.ts.map ├── Math │ ├── index.d.ts │ └── index.d.ts.map ├── Notify │ ├── index.d.ts │ └── index.d.ts.map ├── Number │ ├── index.d.ts │ └── index.d.ts.map ├── Object │ ├── index.d.ts │ └── index.d.ts.map ├── Others │ ├── index.d.ts │ └── index.d.ts.map ├── Promise │ ├── index.d.ts │ └── index.d.ts.map ├── Request │ ├── index.d.ts │ └── index.d.ts.map ├── Storage │ ├── index.d.ts │ └── index.d.ts.map ├── String │ ├── index.d.ts │ └── index.d.ts.map ├── Toast │ ├── index.d.ts │ └── index.d.ts.map ├── Tools │ ├── index.d.ts │ └── index.d.ts.map ├── Types │ ├── index.d.ts │ └── index.d.ts.map ├── WebSocket │ ├── index.d.ts │ └── index.d.ts.map ├── i18n │ ├── index.d.ts │ └── index.d.ts.map ├── index.d.ts ├── index.d.ts.map ├── index.js └── index.source.js ├── docs ├── README.md ├── assets │ └── custom.css ├── classes │ └── i18n.md ├── enumerations │ └── HttpMethod.md ├── functions │ ├── $t.md │ ├── Loading.md │ ├── Speaker.md │ ├── Toast.md │ ├── abs.md │ ├── add.md │ ├── addLongPressEvent.md │ ├── addSpace.md │ ├── all.md │ ├── any.md │ ├── appendLink.md │ ├── appendScript.md │ ├── arr2select.md │ ├── arrObj2objArr.md │ ├── arrayFill.md │ ├── arrayShuffle.md │ ├── arraySort.md │ ├── average.md │ ├── banConsole.md │ ├── base64Decode.md │ ├── base64Encode.md │ ├── bindMoreClick.md │ ├── buf2obj.md │ ├── calcCron.md │ ├── calcDate.md │ ├── calcFontSize.md │ ├── calculate.md │ ├── catchPromise.md │ ├── changeURL.md │ ├── checkFileExt.md │ ├── checkIdCard.md │ ├── checkPassWordLevel.md │ ├── checkUpdate.md │ ├── checkVersion.md │ ├── clearCookies.md │ ├── clearObject.md │ ├── closeFullscreen.md │ ├── closeWebSocket.md │ ├── compareDate.md │ ├── compareTo.md │ ├── contains.md │ ├── copyToClipboard.md │ ├── countdown.md │ ├── createBroadcastChannel.md │ ├── createChangeLogListener.md │ ├── createClickLogListener.md │ ├── createCustomScroll.md │ ├── createIdleListener.md │ ├── createScrollLogListener.md │ ├── createTimeLogListener.md │ ├── curryIt.md │ ├── customFinally.md │ ├── cx.md │ ├── data2Arr.md │ ├── data2Obj.md │ ├── dataTo.md │ ├── debounce.md │ ├── decrypt.md │ ├── deepClone.md │ ├── difference.md │ ├── disableConflictEvent.md │ ├── div.md │ ├── download.md │ ├── downloadContent.md │ ├── downloadFile.md │ ├── downloadImg.md │ ├── emitEvent.md │ ├── emitKeyboardEvent.md │ ├── empty.md │ ├── encrypt.md │ ├── eslintRules.md │ ├── every.md │ ├── exportFile.md │ ├── filterTreeData.md │ ├── findChildren.md │ ├── findMaxKey.md │ ├── findParents.md │ ├── float.md │ ├── forEach.md │ ├── forceToStr.md │ ├── formDataToObject.md │ ├── formatBytes.md │ ├── formatDate.md │ ├── formatJSON.md │ ├── formatNumber.md │ ├── formatRh.md │ ├── getAge.md │ ├── getAnimal.md │ ├── getBSColor.md │ ├── getBaseURL.md │ ├── getBloodGroup.md │ ├── getBrowserLang.md │ ├── getConstellation.md │ ├── getContentType.md │ ├── getCookie.md │ ├── getCryptoJS.md │ ├── getDataStr.md │ ├── getDateDifference.md │ ├── getDateList.md │ ├── getDateTime.md │ ├── getDayInYear.md │ ├── getDecodeStorage.md │ ├── getDefaultLang.md │ ├── getFileNameFromStr.md │ ├── getFileType.md │ ├── getFingerprint.md │ ├── getFirstVar.md │ ├── getKey.md │ ├── getLastVar.md │ ├── getLocalArr.md │ ├── getLocalObj.md │ ├── getMockData.md │ ├── getMonthDayCount.md │ ├── getMonthInfo.md │ ├── getNumberReg.md │ ├── getObjectValue.md │ ├── getPercentage.md │ ├── getPinYin.md │ ├── getQueryString.md │ ├── getRandColor.md │ ├── getRandDate.md │ ├── getRandIp.md │ ├── getRandNum.md │ ├── getRandStr.md │ ├── getRandVar.md │ ├── getScrollParent.md │ ├── getScrollPercent.md │ ├── getSearchParams.md │ ├── getSelectText.md │ ├── getSessionArr.md │ ├── getSessionObj.md │ ├── getSortVar.md │ ├── getStyleByName.md │ ├── getTableColumns.md │ ├── getTimeCode.md │ ├── getTimezone.md │ ├── getTreeCheckNodes.md │ ├── getTreeData.md │ ├── getType.md │ ├── getUTCTime.md │ ├── getUserAgent.md │ ├── getV.md │ ├── getVarSize.md │ ├── getViewportSize.md │ ├── getWebSocket.md │ ├── getWeekInfo.md │ ├── globalError.md │ ├── hasKey.md │ ├── hasSpecialChar.md │ ├── hideToast.md │ ├── html2str.md │ ├── inRange.md │ ├── initNotification.md │ ├── initWebSocket.md │ ├── insertAfter.md │ ├── intersection.md │ ├── inversion.md │ ├── isAccount.md │ ├── isAppleDevice.md │ ├── isArr.md │ ├── isArrayBuffer.md │ ├── isBankCard.md │ ├── isBlob.md │ ├── isBool.md │ ├── isBrowser.md │ ├── isCSR.md │ ├── isCarCode.md │ ├── isChinese.md │ ├── isChrome.md │ ├── isCreditCode.md │ ├── isDarkMode.md │ ├── isDate.md │ ├── isDecimal.md │ ├── isElement.md │ ├── isEmail.md │ ├── isEnglish.md │ ├── isEqual.md │ ├── isEven.md │ ├── isFn.md │ ├── isHttp.md │ ├── isInteger.md │ ├── isInvalidDate.md │ ├── isIpAddress.md │ ├── isIpv4.md │ ├── isIpv6.md │ ├── isJSON.md │ ├── isLatitude.md │ ├── isLocalHost.md │ ├── isLongitude.md │ ├── isMac.md │ ├── isMobile.md │ ├── isNaN.md │ ├── isNode.md │ ├── isNull.md │ ├── isNum.md │ ├── isObj.md │ ├── isPromise.md │ ├── isQQ.md │ ├── isRhNegative.md │ ├── isStr.md │ ├── isStrongPassWord.md │ ├── isTel.md │ ├── isUndef.md │ ├── isUrl.md │ ├── isWeekday.md │ ├── isWin.md │ ├── javaDecrypt.md │ ├── javaEncrypt.md │ ├── jsonClone.md │ ├── keyBoardResize.md │ ├── leftJoin.md │ ├── loadStr.md │ ├── localStorageGet.md │ ├── localStorageSet.md │ ├── log.md │ ├── logRunTime.md │ ├── markNumber.md │ ├── marquee.md │ ├── maskString.md │ ├── md5.md │ ├── ms.md │ ├── obj2buf.md │ ├── observeResource.md │ ├── offDefaultEvent.md │ ├── onClick2MoreClick.md │ ├── onResize.md │ ├── openFileSelect.md │ ├── openFullscreen.md │ ├── openPreviewFile.md │ ├── parseJSON.md │ ├── playAudio.md │ ├── prettierRules.md │ ├── printDom.md │ ├── px2rem.md │ ├── qsParse.md │ ├── qsStringify.md │ ├── readFileContent.md │ ├── removeCookie.md │ ├── removeTag.md │ ├── renderTemplate.md │ ├── repeat.md │ ├── retry.md │ ├── rightJoin.md │ ├── rip.md │ ├── round.md │ ├── safeDecodeURI.md │ ├── safeEncodeURI.md │ ├── same.md │ ├── saveAs.md │ ├── scrollToElement.md │ ├── scrollToView.md │ ├── scrollXTo.md │ ├── scrollYTo.md │ ├── searchTreeData.md │ ├── sendNotification.md │ ├── sendWsMsg.md │ ├── sessionStorageGet.md │ ├── sessionStorageSet.md │ ├── setCookie.md │ ├── setEncodeStorage.md │ ├── setEventListener.md │ ├── setIcon.md │ ├── setWsBinaryType.md │ ├── sha1.md │ ├── sha256.md │ ├── showProcess.md │ ├── showToast.md │ ├── showVar.md │ ├── sleep.md │ ├── slugify.md │ ├── sortBy.md │ ├── sortCallBack.md │ ├── sortJSON.md │ ├── splitString.md │ ├── stackSticky.md │ ├── str2html.md │ ├── str2unicode.md │ ├── stringifyJSON.md │ ├── sub.md │ ├── textCamelCase.md │ ├── textSplitCase.md │ ├── textTransferCase.md │ ├── throttle.md │ ├── timeSince.md │ ├── times.md │ ├── to.md │ ├── toBool.md │ ├── toFormData.md │ ├── toNum.md │ ├── toQueryString.md │ ├── toStr.md │ ├── toggleClass.md │ ├── transferCSVData.md │ ├── transferFileToBase64.md │ ├── transferIdCard.md │ ├── transferMoney.md │ ├── transferNumber.md │ ├── transferQueryParams.md │ ├── transferScanStr.md │ ├── transferSeconds.md │ ├── transferTemperature.md │ ├── transferTreeData.md │ ├── trim.md │ ├── truncate.md │ ├── unicode2str.md │ ├── union.md │ ├── unique.md │ ├── useStateData.md │ ├── uuid.md │ ├── versionUpgrade.md │ ├── waitUntil.md │ ├── watermark.md │ ├── xAjax.md │ ├── xFetch.md │ └── xTimer.md ├── interfaces │ ├── CustomKeys.md │ ├── MockOptions.md │ ├── i18nLanguageResource.md │ └── i18nOptions.md ├── type-aliases │ ├── CryptoOptions.md │ ├── CustomAny.md │ ├── FileType.md │ ├── MockDataType.md │ └── xToastOptions.md └── variables │ ├── ANIMALS.md │ ├── BASE_CHAR_LOW.md │ ├── BASE_CHAR_UP.md │ ├── BASE_NUMBER.md │ ├── BLOOD_GROUP.md │ ├── BLOOD_GROUP_INFO.md │ ├── BS_COLORS.md │ ├── CODE_MSG.md │ ├── CONSTELLATION.md │ ├── CONTENT_TYPES.md │ ├── ICONS.md │ ├── ID_CARD_PROVINCE.md │ ├── KEYBOARD_CODE.md │ ├── MAN.md │ ├── MONTHS.md │ ├── PY_MAPS.md │ ├── ROLES.md │ ├── TRANSFER_STR.md │ ├── WEEKS.md │ └── WOMAN.md ├── es ├── Array │ ├── index.d.ts │ └── index.d.ts.map ├── Cookies │ ├── index.d.ts │ └── index.d.ts.map ├── Crypto │ ├── index.d.ts │ └── index.d.ts.map ├── Data │ ├── index.d.ts │ └── index.d.ts.map ├── Date │ ├── index.d.ts │ └── index.d.ts.map ├── Dev │ ├── index.d.ts │ └── index.d.ts.map ├── Dom │ ├── index.d.ts │ └── index.d.ts.map ├── File │ ├── index.d.ts │ └── index.d.ts.map ├── Form │ ├── index.d.ts │ └── index.d.ts.map ├── Math │ ├── index.d.ts │ └── index.d.ts.map ├── Notify │ ├── index.d.ts │ └── index.d.ts.map ├── Number │ ├── index.d.ts │ └── index.d.ts.map ├── Object │ ├── index.d.ts │ └── index.d.ts.map ├── Others │ ├── index.d.ts │ └── index.d.ts.map ├── Promise │ ├── index.d.ts │ └── index.d.ts.map ├── Request │ ├── index.d.ts │ └── index.d.ts.map ├── Storage │ ├── index.d.ts │ └── index.d.ts.map ├── String │ ├── index.d.ts │ └── index.d.ts.map ├── Toast │ ├── index.d.ts │ └── index.d.ts.map ├── Tools │ ├── index.d.ts │ └── index.d.ts.map ├── Types │ ├── index.d.ts │ └── index.d.ts.map ├── WebSocket │ ├── index.d.ts │ └── index.d.ts.map ├── i18n │ ├── index.d.ts │ └── index.d.ts.map ├── index.d.ts ├── index.d.ts.map ├── index.js └── index.source.js ├── html ├── .nojekyll ├── assets │ ├── custom.css │ ├── highlight.css │ ├── icons.js │ ├── icons.svg │ ├── main.js │ ├── navigation.js │ ├── search.js │ └── style.css ├── classes │ └── i18n.html ├── docs.onload.js ├── enums │ └── HttpMethod.html ├── functions │ ├── Loading.html │ ├── Speaker.html │ ├── Toast.html │ ├── _t.html │ ├── abs.html │ ├── add.html │ ├── addLongPressEvent.html │ ├── addSpace.html │ ├── all.html │ ├── any.html │ ├── appendLink.html │ ├── appendScript.html │ ├── arr2select.html │ ├── arrObj2objArr.html │ ├── arrayFill.html │ ├── arrayShuffle.html │ ├── arraySort.html │ ├── average.html │ ├── banConsole.html │ ├── base64Decode.html │ ├── base64Encode.html │ ├── bindMoreClick.html │ ├── buf2obj.html │ ├── calcCron.html │ ├── calcDate.html │ ├── calcFontSize.html │ ├── calculate.html │ ├── catchPromise.html │ ├── changeURL.html │ ├── checkFileExt.html │ ├── checkIdCard.html │ ├── checkPassWordLevel.html │ ├── checkUpdate.html │ ├── checkVersion.html │ ├── clearCookies.html │ ├── clearObject.html │ ├── closeFullscreen.html │ ├── closeWebSocket.html │ ├── compareDate.html │ ├── compareTo.html │ ├── contains.html │ ├── copyToClipboard.html │ ├── countdown.html │ ├── createBroadcastChannel.html │ ├── createChangeLogListener.html │ ├── createClickLogListener.html │ ├── createCustomScroll.html │ ├── createIdleListener.html │ ├── createScrollLogListener.html │ ├── createTimeLogListener.html │ ├── curryIt.html │ ├── customFinally.html │ ├── cx.html │ ├── data2Arr.html │ ├── data2Obj.html │ ├── dataTo.html │ ├── debounce.html │ ├── decrypt.html │ ├── deepClone.html │ ├── difference.html │ ├── disableConflictEvent.html │ ├── div.html │ ├── download.html │ ├── downloadContent.html │ ├── downloadFile.html │ ├── downloadImg.html │ ├── emitEvent.html │ ├── emitKeyboardEvent.html │ ├── empty.html │ ├── encrypt.html │ ├── eslintRules.html │ ├── every.html │ ├── exportFile.html │ ├── filterTreeData.html │ ├── findChildren.html │ ├── findMaxKey.html │ ├── findParents.html │ ├── float.html │ ├── forEach.html │ ├── forceToStr.html │ ├── formDataToObject.html │ ├── formatBytes.html │ ├── formatDate.html │ ├── formatJSON.html │ ├── formatNumber.html │ ├── formatRh.html │ ├── getAge.html │ ├── getAnimal.html │ ├── getBSColor.html │ ├── getBaseURL.html │ ├── getBloodGroup.html │ ├── getBrowserLang.html │ ├── getConstellation.html │ ├── getContentType.html │ ├── getCookie.html │ ├── getCryptoJS.html │ ├── getDataStr.html │ ├── getDateDifference.html │ ├── getDateList.html │ ├── getDateTime.html │ ├── getDayInYear.html │ ├── getDecodeStorage.html │ ├── getDefaultLang.html │ ├── getFileNameFromStr.html │ ├── getFileType.html │ ├── getFingerprint.html │ ├── getFirstVar.html │ ├── getKey.html │ ├── getLastVar.html │ ├── getLocalArr.html │ ├── getLocalObj.html │ ├── getMockData.html │ ├── getMonthDayCount.html │ ├── getMonthInfo.html │ ├── getNumberReg.html │ ├── getObjectValue.html │ ├── getPercentage.html │ ├── getPinYin.html │ ├── getQueryString.html │ ├── getRandColor.html │ ├── getRandDate.html │ ├── getRandIp.html │ ├── getRandNum.html │ ├── getRandStr.html │ ├── getRandVar.html │ ├── getScrollParent.html │ ├── getScrollPercent.html │ ├── getSearchParams.html │ ├── getSelectText.html │ ├── getSessionArr.html │ ├── getSessionObj.html │ ├── getSortVar.html │ ├── getStyleByName.html │ ├── getTableColumns.html │ ├── getTimeCode.html │ ├── getTimezone.html │ ├── getTreeCheckNodes.html │ ├── getTreeData.html │ ├── getType.html │ ├── getUTCTime.html │ ├── getUserAgent.html │ ├── getV.html │ ├── getVarSize.html │ ├── getViewportSize.html │ ├── getWebSocket.html │ ├── getWeekInfo.html │ ├── globalError.html │ ├── hasKey.html │ ├── hasSpecialChar.html │ ├── hideToast.html │ ├── html2str.html │ ├── inRange.html │ ├── initNotification.html │ ├── initWebSocket.html │ ├── insertAfter.html │ ├── intersection.html │ ├── inversion.html │ ├── isAccount.html │ ├── isAppleDevice.html │ ├── isArr.html │ ├── isArrayBuffer.html │ ├── isBankCard.html │ ├── isBlob.html │ ├── isBool.html │ ├── isBrowser.html │ ├── isCSR.html │ ├── isCarCode.html │ ├── isChinese.html │ ├── isChrome.html │ ├── isCreditCode.html │ ├── isDarkMode.html │ ├── isDate.html │ ├── isDecimal.html │ ├── isElement.html │ ├── isEmail.html │ ├── isEnglish.html │ ├── isEqual.html │ ├── isEven.html │ ├── isFn.html │ ├── isHttp.html │ ├── isInteger.html │ ├── isInvalidDate.html │ ├── isIpAddress.html │ ├── isIpv4.html │ ├── isIpv6.html │ ├── isJSON.html │ ├── isLatitude.html │ ├── isLocalHost.html │ ├── isLongitude.html │ ├── isMac.html │ ├── isMobile.html │ ├── isNaN.html │ ├── isNode.html │ ├── isNull.html │ ├── isNum.html │ ├── isObj.html │ ├── isPromise.html │ ├── isQQ.html │ ├── isRhNegative.html │ ├── isStr.html │ ├── isStrongPassWord.html │ ├── isTel.html │ ├── isUndef.html │ ├── isUrl.html │ ├── isWeekday.html │ ├── isWin.html │ ├── javaDecrypt.html │ ├── javaEncrypt.html │ ├── jsonClone.html │ ├── keyBoardResize.html │ ├── leftJoin.html │ ├── loadStr.html │ ├── localStorageGet.html │ ├── localStorageSet.html │ ├── log.html │ ├── logRunTime.html │ ├── markNumber.html │ ├── marquee.html │ ├── maskString.html │ ├── md5.html │ ├── ms.html │ ├── obj2buf.html │ ├── observeResource.html │ ├── offDefaultEvent.html │ ├── onClick2MoreClick.html │ ├── onResize.html │ ├── openFileSelect.html │ ├── openFullscreen.html │ ├── openPreviewFile.html │ ├── parseJSON.html │ ├── playAudio.html │ ├── prettierRules.html │ ├── printDom.html │ ├── px2rem.html │ ├── qsParse.html │ ├── qsStringify.html │ ├── readFileContent.html │ ├── removeCookie.html │ ├── removeTag.html │ ├── renderTemplate.html │ ├── repeat.html │ ├── retry.html │ ├── rightJoin.html │ ├── rip.html │ ├── round.html │ ├── safeDecodeURI.html │ ├── safeEncodeURI.html │ ├── same.html │ ├── saveAs.html │ ├── scrollToElement.html │ ├── scrollToView.html │ ├── scrollXTo.html │ ├── scrollYTo.html │ ├── searchTreeData.html │ ├── sendNotification.html │ ├── sendWsMsg.html │ ├── sessionStorageGet.html │ ├── sessionStorageSet.html │ ├── setCookie.html │ ├── setEncodeStorage.html │ ├── setEventListener.html │ ├── setIcon.html │ ├── setWsBinaryType.html │ ├── sha1.html │ ├── sha256.html │ ├── showProcess.html │ ├── showToast.html │ ├── showVar.html │ ├── sleep.html │ ├── slugify.html │ ├── sortBy.html │ ├── sortCallBack.html │ ├── sortJSON.html │ ├── splitString.html │ ├── stackSticky.html │ ├── str2html.html │ ├── str2unicode.html │ ├── stringifyJSON.html │ ├── sub.html │ ├── textCamelCase.html │ ├── textSplitCase.html │ ├── textTransferCase.html │ ├── throttle.html │ ├── timeSince.html │ ├── times.html │ ├── to.html │ ├── toBool.html │ ├── toFormData.html │ ├── toNum.html │ ├── toQueryString.html │ ├── toStr.html │ ├── toggleClass.html │ ├── transferCSVData.html │ ├── transferFileToBase64.html │ ├── transferIdCard.html │ ├── transferMoney.html │ ├── transferNumber.html │ ├── transferQueryParams.html │ ├── transferScanStr.html │ ├── transferSeconds.html │ ├── transferTemperature.html │ ├── transferTreeData.html │ ├── trim.html │ ├── truncate.html │ ├── unicode2str.html │ ├── union.html │ ├── unique.html │ ├── useStateData.html │ ├── uuid.html │ ├── versionUpgrade.html │ ├── waitUntil.html │ ├── watermark.html │ ├── xAjax.html │ ├── xFetch.html │ └── xTimer.html ├── index.html ├── interfaces │ ├── CustomKeys.html │ ├── MockOptions.html │ ├── i18nLanguageResource.html │ └── i18nOptions.html ├── js-xxx.min.js ├── types │ ├── CryptoOptions.html │ ├── CustomAny.html │ ├── FileType.html │ ├── MockDataType.html │ └── xToastOptions.html └── variables │ ├── ANIMALS.html │ ├── BASE_CHAR_LOW.html │ ├── BASE_CHAR_UP.html │ ├── BASE_NUMBER.html │ ├── BLOOD_GROUP.html │ ├── BLOOD_GROUP_INFO.html │ ├── BS_COLORS.html │ ├── CODE_MSG.html │ ├── CONSTELLATION.html │ ├── CONTENT_TYPES.html │ ├── ICONS.html │ ├── ID_CARD_PROVINCE.html │ ├── KEYBOARD_CODE.html │ ├── MAN.html │ ├── MONTHS.html │ ├── PY_MAPS.html │ ├── ROLES.html │ ├── TRANSFER_STR.html │ ├── WEEKS.html │ └── WOMAN.html ├── iife ├── Array │ ├── index.d.ts │ └── index.d.ts.map ├── Cookies │ ├── index.d.ts │ └── index.d.ts.map ├── Crypto │ ├── index.d.ts │ └── index.d.ts.map ├── Data │ ├── index.d.ts │ └── index.d.ts.map ├── Date │ ├── index.d.ts │ └── index.d.ts.map ├── Dev │ ├── index.d.ts │ └── index.d.ts.map ├── Dom │ ├── index.d.ts │ └── index.d.ts.map ├── File │ ├── index.d.ts │ └── index.d.ts.map ├── Form │ ├── index.d.ts │ └── index.d.ts.map ├── Math │ ├── index.d.ts │ └── index.d.ts.map ├── Notify │ ├── index.d.ts │ └── index.d.ts.map ├── Number │ ├── index.d.ts │ └── index.d.ts.map ├── Object │ ├── index.d.ts │ └── index.d.ts.map ├── Others │ ├── index.d.ts │ └── index.d.ts.map ├── Promise │ ├── index.d.ts │ └── index.d.ts.map ├── Request │ ├── index.d.ts │ └── index.d.ts.map ├── Storage │ ├── index.d.ts │ └── index.d.ts.map ├── String │ ├── index.d.ts │ └── index.d.ts.map ├── Toast │ ├── index.d.ts │ └── index.d.ts.map ├── Tools │ ├── index.d.ts │ └── index.d.ts.map ├── Types │ ├── index.d.ts │ └── index.d.ts.map ├── WebSocket │ ├── index.d.ts │ └── index.d.ts.map ├── i18n │ ├── index.d.ts │ └── index.d.ts.map ├── index.d.ts ├── index.d.ts.map ├── index.min.js └── index.source.js ├── lib ├── Array │ ├── index.d.ts │ └── index.d.ts.map ├── Cookies │ ├── index.d.ts │ └── index.d.ts.map ├── Crypto │ ├── index.d.ts │ └── index.d.ts.map ├── Data │ ├── index.d.ts │ └── index.d.ts.map ├── Date │ ├── index.d.ts │ └── index.d.ts.map ├── Dev │ ├── index.d.ts │ └── index.d.ts.map ├── Dom │ ├── index.d.ts │ └── index.d.ts.map ├── File │ ├── index.d.ts │ └── index.d.ts.map ├── Form │ ├── index.d.ts │ └── index.d.ts.map ├── Math │ ├── index.d.ts │ └── index.d.ts.map ├── Notify │ ├── index.d.ts │ └── index.d.ts.map ├── Number │ ├── index.d.ts │ └── index.d.ts.map ├── Object │ ├── index.d.ts │ └── index.d.ts.map ├── Others │ ├── index.d.ts │ └── index.d.ts.map ├── Promise │ ├── index.d.ts │ └── index.d.ts.map ├── Request │ ├── index.d.ts │ └── index.d.ts.map ├── Storage │ ├── index.d.ts │ └── index.d.ts.map ├── String │ ├── index.d.ts │ └── index.d.ts.map ├── Toast │ ├── index.d.ts │ └── index.d.ts.map ├── Tools │ ├── index.d.ts │ └── index.d.ts.map ├── Types │ ├── index.d.ts │ └── index.d.ts.map ├── WebSocket │ ├── index.d.ts │ └── index.d.ts.map ├── i18n │ ├── index.d.ts │ └── index.d.ts.map ├── index.d.ts ├── index.d.ts.map ├── index.js └── index.source.js ├── package.json ├── rollup.config.js ├── src ├── Array │ └── index.ts ├── Cookies │ └── index.ts ├── Crypto │ └── index.ts ├── Data │ ├── blobTypes.js │ └── index.ts ├── Date │ └── index.ts ├── Dev │ ├── index.ts │ └── 此目录禁止手动修改 ├── Dom │ └── index.ts ├── File │ └── index.ts ├── Form │ └── index.ts ├── Math │ └── index.ts ├── Notify │ └── index.ts ├── Number │ └── index.ts ├── Object │ └── index.ts ├── Others │ └── index.ts ├── Promise │ └── index.ts ├── Request │ └── index.ts ├── Storage │ └── index.ts ├── String │ └── index.ts ├── Toast │ └── index.ts ├── Tools │ └── index.ts ├── Types │ └── index.ts ├── WebSocket │ └── index.ts ├── i18n │ └── index.ts └── index.ts ├── tsconfig.json └── typedoc.json /.editorconfig: -------------------------------------------------------------------------------- 1 | # 编辑器配置 2 | # .editorconfig 3 | # http://editorconfig.org 4 | root = true # 是否是顶级配置文件，设置为 true 的时候才会停止搜索 .editorconfig 文件，一般我们项目只设置一个。 5 | 6 | [*] 7 | charset = utf-8 # 编码格式 8 | end_of_line = lf # 换行符类型 9 | indent_size = 2 # 缩进大小 10 | indent_style = space # 缩进方式 11 | insert_final_newline = true # 是否让文件以空行结束 12 | max_line_length = 120 # 最大行宽 13 | trim_trailing_whitespace = true # 是否删除行尾空格 14 | 15 | [*.md] 16 | max_line_length = 120 17 | -------------------------------------------------------------------------------- /.eslintignore: -------------------------------------------------------------------------------- 1 | /* 2 | !/src/ 3 | !_docs.custom.css 4 | !tsconfig.json 5 | !typedoc.json -------------------------------------------------------------------------------- /.eslintrc.js: -------------------------------------------------------------------------------- 1 | /* 2 | * @Author: HxB 3 | * @Date: 2023-03-13 15:05:27 4 | * @LastEditors: DoubleAm 5 | * @LastEditTime: 2024-05-11 11:32:19 6 | * @Description: eslint 配置文件 7 | * @FilePath: \js-xxx\.eslintrc.js 8 | */ 9 | const { eslintRules } = require('./dev.config.js'); 10 | 11 | module.exports = { 12 | env: { 13 | browser: true, 14 | node: true, 15 | }, 16 | extends: ['prettier', 'eslint:recommended', 'plugin:@typescript-eslint/recommended'], 17 | overrides: [], 18 | parser: '@typescript-eslint/parser', 19 | parserOptions: { 20 | ecmaVersion: 'latest', 21 | sourceType: 'module', 22 | }, 23 | plugins: ['prettier', '@typescript-eslint', 'spellcheck', 'import', 'zob'], 24 | rules: eslintRules(), 25 | }; 26 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store/** 2 | .idea/** 3 | .vscode/** 4 | **/node_modules/** 5 | **/test/** 6 | **/package-lock.json 7 | 8 | # Logs 9 | **/logs/** 10 | **/**.log 11 | npm-debug.log* 12 | yarn-debug.log* 13 | pnpm-debug.log* 14 | 15 | # Custom 16 | .husky/** 17 | **/.umi/** 18 | **/.next/** -------------------------------------------------------------------------------- /.prettierignore: -------------------------------------------------------------------------------- 1 | /* 2 | !/*.js 3 | !/src/ 4 | !_docs.custom.css 5 | !tsconfig.json 6 | !typedoc.json 7 | !/demo/ 8 | !/*.md -------------------------------------------------------------------------------- /.prettierrc.js: -------------------------------------------------------------------------------- 1 | /* 2 | * @Author: HxB 3 | * @Date: 2023-03-13 15:20:08 4 | * @LastEditors: DoubleAm 5 | * @LastEditTime: 2024-05-11 11:30:33 6 | * @Description: .prettierrc.js 7 | * @FilePath: \js-xxx\.prettierrc.js 8 | */ 9 | const { prettierRules } = require('./dev.config.js'); 10 | 11 | module.exports = prettierRules(); 12 | -------------------------------------------------------------------------------- /dist/Cookies/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Cookies/index.ts"],"names":[],"mappings":"AASA;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAK1C;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,QAQjE;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,QAOvC;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,SAO3B"} -------------------------------------------------------------------------------- /dist/Dev/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Dev/index.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;CAoBxB,CAAC;AAEH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuMtB,CAAC;AAEH,eAAO,MAAM,QAAQ,sBAsCpB,CAAC"} -------------------------------------------------------------------------------- /dist/Form/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Form/index.ts"],"names":[],"mappings":"AAUA;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,WAAW,UAAQ,EAAE,QAAQ,UAAQ,GAAG,QAAQ,CAepF;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,GAAG,OA4B7C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,WAAW,UAAQ,EAAE,QAAQ,UAAQ,GAAG,eAAe,CAe9F;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,YAAY,CAAC,WAAW,EAAE,GAAG,YAOnB,GAAG,YAqB5B"} -------------------------------------------------------------------------------- /dist/Notify/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Notify/index.ts"],"names":[],"mappings":"AAUA;;;;;;GAMG;AACH,wBAAgB,gBAAgB,IAAI,OAAO,CAwB1C;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,MAAM,EACX,KAAK,CAAC,EAAE,MAAM,EACd,OAAO,CAAC,EACJ;IACE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,CAAC;IAC7B,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IACzB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,aAAa,GAAG,MAAM,CAAC;IAE9B,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,OAAO,CAAC,EAAE,GAAG,CAAC;CACf,GAED,mBAAmB,GACnB,SAAS,GACZ,IAAI,CAgCN"} -------------------------------------------------------------------------------- /dist/Number/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Number/index.ts"],"names":[],"mappings":"AASA;;;;;;;;;;;;GAYG;AACH,wBAAgB,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAiDpD;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,OAAO,CAQlE;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,GAAG,EAAE,UAAU,UAAQ,GAAG,OAAO,CAatF;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,SAAI,GAAG,MAAM,CAoBlE;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE;IAAE,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAKpF"} -------------------------------------------------------------------------------- /dist/Object/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Object/index.ts"],"names":[],"mappings":"AAWA;;;;;;;;;;;;GAYG;AACH,wBAAgB,IAAI,CAAC,aAAa,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,GAAG,GAAG,CAgB1D;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CActD;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,uBAAgB,GAAG,GAAG,CAqC9D;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,KAAK,CAAC,UAAU,EAAE,GAAG,EAAE,QAAQ,CAAC,EAAE,GAAG,WAqBpD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,GAAG,EAAE,WAyBzC;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE;IAAE,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,GAAG,EAAE,CA+BtG;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,cAAc,QAAS,GAAG,QAAa,MAAM,EAAE,iBAAiB,GAAG,QAQ/E,CAAC"} -------------------------------------------------------------------------------- /dist/Toast/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Toast/index.ts"],"names":[],"mappings":"AAaA;;;;GAIG;AACH,oBAAY,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;IACxE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,YAqDM,aAAa,mBAIrC,CAAC;AAEL;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,KAAK,CAAC,EAAE,GAAG,QAUpC;AAED;;;;;;;;GAQG;AACH,wBAAgB,KAAK,CACnB,GAAG,EAAE,MAAM,EACX,IAAI,GAAE,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,SAAqB,GACjF,GAAG,CASL;AAED;;;;;;;GAOG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAMxC"} -------------------------------------------------------------------------------- /dist/index.d.ts: -------------------------------------------------------------------------------- 1 | export * from './Dev'; 2 | export * from './Array'; 3 | export * from './Cookies'; 4 | export * from './Crypto'; 5 | export * from './Data'; 6 | export * from './Date'; 7 | export * from './Dom'; 8 | export * from './File'; 9 | export * from './Form'; 10 | export * from './Math'; 11 | export * from './Notify'; 12 | export * from './Number'; 13 | export * from './Object'; 14 | export * from './Others'; 15 | export * from './Promise'; 16 | export * from './Request'; 17 | export * from './Storage'; 18 | export * from './String'; 19 | export * from './Toast'; 20 | export * from './Tools'; 21 | export * from './Types'; 22 | export * from './WebSocket'; 23 | export * from './i18n'; 24 | //# sourceMappingURL=index.d.ts.map -------------------------------------------------------------------------------- /dist/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAeA,cAAc,OAAO,CAAC;AAEtB,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,QAAQ,CAAC;AACvB,cAAc,OAAO,CAAC;AACtB,cAAc,QAAQ,CAAC;AACvB,cAAc,QAAQ,CAAC;AACvB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,QAAQ,CAAC"} -------------------------------------------------------------------------------- /docs/functions/$t.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / $t 6 | 7 | # Function: $t() 8 | 9 | > **$t**(`s`): `string` 10 | 11 | 用于插件扫描自定义多语言 key，方便 excel 或者 json 生成。 12 | 13 | ## Parameters 14 | 15 | • **s**: `any` 16 | 17 | ## Returns 18 | 19 | `string` 20 | 21 | ## Example 22 | 23 | ```ts 24 | $t('aaa'); /// 'aaa' 25 | ``` 26 | -------------------------------------------------------------------------------- /docs/functions/Loading.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / Loading 6 | 7 | # Function: Loading() 8 | 9 | > **Loading**(`msg`): `any` 10 | 11 | Loading Toast 不会自动关闭 12 | 13 | ## Parameters 14 | 15 | • **msg**: `string` 16 | 17 | 内容 18 | 19 | ## Returns 20 | 21 | `any` 22 | 23 | ## Example 24 | 25 | ```ts 26 | const hide = Loading(msg?); /// hide(); 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/Toast.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / Toast 6 | 7 | # Function: Toast() 8 | 9 | > **Toast**(`msg`, `type`): `any` 10 | 11 | 快速展示 Toast 12 | 13 | ## Parameters 14 | 15 | • **msg**: `string` 16 | 17 | 内容 18 | 19 | • **type**: `"success"` \| `"error"` \| `"default"` \| `"info"` \| `"warning"` \| `"loading"` = `'default'` 20 | 21 | 类型 22 | 23 | ## Returns 24 | 25 | `any` 26 | 27 | ## Example 28 | 29 | ```ts 30 | const hide = Toast('这是一个快速演示 Toast'); /// hide(); 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/functions/abs.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / abs 6 | 7 | # Function: abs() 8 | 9 | > **abs**(`value`): `number` 10 | 11 | 获取绝对值 12 | 13 | ## Parameters 14 | 15 | • **value**: `number` 16 | 17 | 数值 18 | 19 | ## Returns 20 | 21 | `number` 22 | 23 | ## Example 24 | 25 | ```ts 26 | abs(-1); /// 1 27 | abs(1); /// 1 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/add.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / add 6 | 7 | # Function: add() 8 | 9 | > **add**(`add1`, `add2`): `number` 10 | 11 | 加法函数 12 | 13 | ## Parameters 14 | 15 | • **add1**: `string` \| `number` 16 | 17 | 被加数 18 | 19 | • **add2**: `string` \| `number` 20 | 21 | 加数 22 | 23 | ## Returns 24 | 25 | `number` 26 | 27 | ## Example 28 | 29 | ```ts 30 | add(1, 2); /// 3 31 | add(0.1, 0.2); /// 0.3 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/addLongPressEvent.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / addLongPressEvent 6 | 7 | # Function: addLongPressEvent() 8 | 9 | > **addLongPressEvent**(`element`, `longPressCallback`, `duration`, `clickCallback`?): `void` 10 | 11 | 设置长按事件-支持加入单击事件 12 | 13 | ## Parameters 14 | 15 | • **element**: `any` 16 | 17 | 需要绑定事件的元素 18 | 19 | • **longPressCallback**: `any` 20 | 21 | 长按事件函数 22 | 23 | • **duration**: `number` = `2500` 24 | 25 | 长按时间 26 | 27 | • **clickCallback?**: `any` 28 | 29 | 单击事件函数(可选) 30 | 31 | ## Returns 32 | 33 | `void` 34 | 35 | ## Example 36 | 37 | ```ts 38 | addLongPressEvent(document.querySelector('.img-btn'), (event); /// console.log('addLongPressEvent'), 3000); /// 长按会触发事件 39 | ``` 40 | -------------------------------------------------------------------------------- /docs/functions/addSpace.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / addSpace 6 | 7 | # Function: addSpace() 8 | 9 | > **addSpace**(`str`): `string` 10 | 11 | 强制给字符串添加空格间隔 12 | 13 | ## Parameters 14 | 15 | • **str**: `string` \| `number` 16 | 17 | 字符串 18 | 19 | ## Returns 20 | 21 | `string` 22 | 23 | ## Example 24 | 25 | ```ts 26 | addSpace('test'); /// 't e s t' 27 | addSpace(null); /// '' 28 | addSpace('123 45'); /// '1 2 3 4 5' 29 | ``` 30 | -------------------------------------------------------------------------------- /docs/functions/all.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / all 6 | 7 | # Function: all() 8 | 9 | > **all**(`promises`, `errorHandler`?): `Promise`\<`any`\> 10 | 11 | 同步执行 promise，已做错误处理。 12 | 13 | ## Parameters 14 | 15 | • **promises**: `Promise`\<`any`\>[] 16 | 17 | promises 18 | 19 | • **errorHandler?**: `any` 20 | 21 | errorHandler 22 | 23 | ## Returns 24 | 25 | `Promise`\<`any`\> 26 | 27 | ## Example 28 | 29 | ```ts 30 | await all(...promise array); /// [...result array] 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/functions/any.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / any 6 | 7 | # Function: any() 8 | 9 | > **any**(`promises`, `errorHandler`?): `Promise`\<`any`\> 10 | 11 | 同步执行多个 promise，返回最先成功的结果，已做错误处理。 12 | 13 | ## Parameters 14 | 15 | • **promises**: `Promise`\<`any`\>[] 16 | 17 | promises 18 | 19 | • **errorHandler?**: `any` 20 | 21 | errorHandler 22 | 23 | ## Returns 24 | 25 | `Promise`\<`any`\> 26 | 27 | ## Example 28 | 29 | ```ts 30 | await any(...promise array); /// success result 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/functions/appendLink.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / appendLink 6 | 7 | # Function: appendLink() 8 | 9 | > **appendLink**(`linkUrl`, `rel`): `HTMLLinkElement` 10 | 11 | 添加 link 标签 12 | 13 | ## Parameters 14 | 15 | • **linkUrl**: `string` 16 | 17 | 链接地址 18 | 19 | • **rel**: `string` = `'stylesheet'` 20 | 21 | 类型 22 | 23 | ## Returns 24 | 25 | `HTMLLinkElement` 26 | 27 | ## Example 28 | 29 | ```ts 30 | appendLink('favicon', 'favicon'); /// 添加一个 link 标签 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/functions/appendScript.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / appendScript 6 | 7 | # Function: appendScript() 8 | 9 | > **appendScript**(`scriptUrl`, `async`, `defer`): `HTMLScriptElement` 10 | 11 | 添加 script 标签 12 | 13 | ## Parameters 14 | 15 | • **scriptUrl**: `string` 16 | 17 | 脚本地址 18 | 19 | • **async**: `boolean` = `false` 20 | 21 | 是否异步 22 | 23 | • **defer**: `boolean` = `false` 24 | 25 | 是否延迟加载 26 | 27 | ## Returns 28 | 29 | `HTMLScriptElement` 30 | 31 | ## Example 32 | 33 | ```ts 34 | appendScript('./test.js'); /// 添加一个 script 标签 35 | ``` 36 | -------------------------------------------------------------------------------- /docs/functions/arrObj2objArr.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / arrObj2objArr 6 | 7 | # Function: arrObj2objArr() 8 | 9 | > **arrObj2objArr**(`data`, `key`): `object` 10 | 11 | 数组对象转换为对象数组，需确保源数据已经去重哦，否则会暴力去重，最后一条数据有效。 12 | 一般图表类插件需要此类转换 13 | 14 | ## Parameters 15 | 16 | • **data**: `object`[] 17 | 18 | 源数据 19 | 20 | • **key**: `string` 21 | 22 | 用于转换的 key 23 | 24 | ## Returns 25 | 26 | `object` 27 | 28 | ## Example 29 | 30 | ```ts 31 | const data = [{ id: 1, name: '张三', score: 98, remark: '语文成绩' }, { id: 3, name: '王五', score: 98 }, { id: 3, name: '王五', score: 99, remark: '最后一条有效成绩' }, { id: 2, name: '李四', score: 100 }]; 32 | arrObj2objArr(data, 'id'); /// {"id": [1, 2, 3], "name": ["张三", "李四", "王五"], "score": [98, 100, 99], "remark": ["语文成绩", null, "最后一条有效成绩"]} 33 | ``` 34 | -------------------------------------------------------------------------------- /docs/functions/arrayFill.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / arrayFill 6 | 7 | # Function: arrayFill() 8 | 9 | > **arrayFill**(`arr`, `n`?): `number`[] 10 | 11 | 填充数组空值，取前后值得中间数。 12 | 13 | ## Parameters 14 | 15 | • **arr**: `any`[] 16 | 17 | 数组 18 | 19 | • **n?**: `number` 20 | 21 | 保留小数位 22 | 23 | ## Returns 24 | 25 | `number`[] 26 | 27 | ## Example 28 | 29 | ```ts 30 | arrayFill([1, undefined, 3, undefined, 4]); /// [1, 2, 3, 3.5, 4] 31 | arrayFill([1, undefined, 3, undefined, 4], 0); ///  [1, 2, 3, 4, 4] 32 | arrayFill([1, undefined, 3, undefined, 10.55], 2); /// [1, 2, 3, 6.78, 10.55] 33 | ``` 34 | -------------------------------------------------------------------------------- /docs/functions/arrayShuffle.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / arrayShuffle 6 | 7 | # Function: arrayShuffle() 8 | 9 | > **arrayShuffle**(`arr`): `any`[] 10 | 11 | 数组乱序 12 | 13 | ## Parameters 14 | 15 | • **arr**: `any`[] 16 | 17 | 数组 18 | 19 | ## Returns 20 | 21 | `any`[] 22 | 23 | ## Example 24 | 25 | ```ts 26 | arrayShuffle([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]); /// [5, 9, 1, 10, 2, 6, 4, 8, 3, 7] 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/average.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / average 6 | 7 | # Function: average() 8 | 9 | > **average**(...`args`): `number` 10 | 11 | 获取平均数 12 | 13 | ## Parameters 14 | 15 | • ...**args**: `any`[] 16 | 17 | 需要计算的数... 18 | 19 | ## Returns 20 | 21 | `number` 22 | 23 | ## Example 24 | 25 | ```ts 26 | average(1, 2, 3, 4); /// 2.5 27 | average(1, 2, 3, 4.123); /// 2.53075 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/banConsole.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / banConsole 6 | 7 | # Function: banConsole() 8 | 9 | > **banConsole**(): `any` 10 | 11 | 禁用控制台 12 | windows 13 | 防君子不防小人 14 | 监听页面大小变化没必要 15 | 监听编辑 dom 事件 reload 也算了 16 | 17 | ## Returns 18 | 19 | `any` 20 | 21 | ## Example 22 | 23 | ```ts 24 | banConsole(); /// 返回取消禁用的 function 25 | ``` 26 | -------------------------------------------------------------------------------- /docs/functions/base64Decode.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / base64Decode 6 | 7 | # Function: base64Decode() 8 | 9 | > **base64Decode**(`str`): `string` 10 | 11 | base64 解密函数 12 | 13 | ## Parameters 14 | 15 | • **str**: `string` 16 | 17 | 需要加密的字符串 18 | 19 | ## Returns 20 | 21 | `string` 22 | 23 | ## Example 24 | 25 | ```ts 26 | base64Decode("加密后的字符串"); /// 解密后的字符串 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/base64Encode.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / base64Encode 6 | 7 | # Function: base64Encode() 8 | 9 | > **base64Encode**(`str`, `replaceChar`): `string` 10 | 11 | base64 加密函数 12 | `使用 url 中时建议使用 encodeURIComponent 再次编码，因为单独 + 号在 url 中会被解析成空格。` 13 | `使用 encodeURIComponent 会把 + 解析为 %2B 与空格 %20 区分` 14 | 15 | ## Parameters 16 | 17 | • **str**: `string` 18 | 19 | 需要加密的字符串 20 | 21 | • **replaceChar**: `boolean` = `false` 22 | 23 | 是否替换结果字符串中的特殊字符 '+/='，适用于 url 编码。 24 | 25 | ## Returns 26 | 27 | `string` 28 | 29 | ## Example 30 | 31 | ```ts 32 | base64Encode("value"); /// 加密后的字符串 33 | base64Encode("value", true); /// 加密后的字符串并替换 +/= 34 | ``` 35 | -------------------------------------------------------------------------------- /docs/functions/bindMoreClick.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / bindMoreClick 6 | 7 | # Function: bindMoreClick() 8 | 9 | > **bindMoreClick**(`fn`, `times`, `delay`): (...`args`) => `void` 10 | 11 | 单独绑定多击事件 12 | 13 | ## Parameters 14 | 15 | • **fn**: `any` 16 | 17 | 触发方法 18 | 19 | • **times**: `number` = `3` 20 | 21 | 几次点击触发 22 | 23 | • **delay**: `number` = `300` 24 | 25 | 点击间隔 26 | 27 | ## Returns 28 | 29 | `Function` 30 | 31 | ### Parameters 32 | 33 | • ...**args**: `any`[] 34 | 35 | ### Returns 36 | 37 | `void` 38 | 39 | ## Example 40 | 41 | ```ts 42 | dom.onclick = bindMoreClick(moreClickCallBack, 4, 500); /// 绑定 4 击事件 43 | ``` 44 | -------------------------------------------------------------------------------- /docs/functions/buf2obj.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / buf2obj 6 | 7 | # Function: buf2obj() 8 | 9 | > **buf2obj**(`data`, `transfer`): `any` 10 | 11 | buffer to object 12 | 13 | ## Parameters 14 | 15 | • **data**: `any` 16 | 17 | buffer 数据 18 | 19 | • **transfer**: `any` 20 | 21 | 转换器 22 | 23 | ## Returns 24 | 25 | `any` 26 | 27 | ## Example 28 | 29 | ```ts 30 | const _protoBuffer = _proto.lookupType('MonitorMessage'); 31 | const obj = buf2obj(event.data, _protoBuffer); 32 | console.log(obj); 33 | ``` 34 | -------------------------------------------------------------------------------- /docs/functions/calcDate.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / calcDate 6 | 7 | # Function: calcDate() 8 | 9 | > **calcDate**(`date`, `calcStrOrArr`): `Date` 10 | 11 | 时间计算 12 | 13 | ## Parameters 14 | 15 | • **date**: `string` \| `Date` 16 | 17 | 时间 18 | 19 | • **calcStrOrArr**: `string` \| `string`[] 20 | 21 | '1 days' or ['-1 day', '3 month'] 22 | 23 | ## Returns 24 | 25 | `Date` 26 | 27 | ## Example 28 | 29 | ```ts 30 | calcDate(new Date(), '-1 days'); /// date object 31 | calcDate(new Date(), '-1 DAYS'); /// date object 32 | calcDate(new Date(), ['-1 day', '+1 year', '-2 month', '2 weeks', '1 hour', '-3 minute', '45 seconds']); /// date object 33 | ``` 34 | -------------------------------------------------------------------------------- /docs/functions/calcFontSize.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / calcFontSize 6 | 7 | # Function: calcFontSize() 8 | 9 | > **calcFontSize**(`clientRatio`, `contentCenter`, `offsetSelector`): () => `void` 10 | 11 | 自动计算 font-size 并设置 12 | 13 | ## Parameters 14 | 15 | • **clientRatio**: `number` = `...` 16 | 17 | 屏幕比例 18 | 19 | • **contentCenter**: `boolean` = `false` 20 | 21 | 内容是否居中 22 | 23 | • **offsetSelector**: `any` 24 | 25 | 偏移元素选择器，默认设置 html 根节点偏移。 26 | 27 | ## Returns 28 | 29 | `Function` 30 | 31 | ### Returns 32 | 33 | `void` 34 | 35 | ## Example 36 | 37 | ```ts 38 | calcFontSize(); /// 按 16/9 计算并设置 39 | calcFontSize(16/10, true); /// 按 16/10 计算并设置内容居中 40 | calcFontSize(16/10, true, 'body'); /// 按 16/10 计算并设置 body 偏移使得内容居中 41 | ``` 42 | -------------------------------------------------------------------------------- /docs/functions/calculate.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / calculate 6 | 7 | # Function: calculate() 8 | 9 | > **calculate**(`operator`, ...`args`): `number` 10 | 11 | 计算所有数 12 | 13 | ## Parameters 14 | 15 | • **operator**: `string` 16 | 17 | 操作符 18 | 19 | • ...**args**: `any`[] 20 | 21 | 需要计算的数... 22 | 23 | ## Returns 24 | 25 | `number` 26 | 27 | ## Example 28 | 29 | ```ts 30 | calculate('+', 1, 2, 3, 4); /// 10 31 | calculate('+', 1, 2, 3, undefined); /// 6 32 | calculate('*', 1, 2, 3); /// 6 33 | calculate('*', 1, 2, 3, undefined); /// 0 34 | calculate('-', 10, 2, 3); /// 5 35 | calculate('/', 10, 2, 2); /// 2.5 36 | ``` 37 | -------------------------------------------------------------------------------- /docs/functions/catchPromise.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / catchPromise 6 | 7 | # Function: catchPromise() 8 | 9 | > **catchPromise**(`promiseHandler`, `errorHandler`?): `Promise`\<`any`\> 10 | 11 | New 一个自带错误处理的 Promise，适用于只处理成功情况，不关注失败的 Promise，省去写 catch 的时间与空间。 12 | 13 | ## Parameters 14 | 15 | • **promiseHandler**: `any` 16 | 17 | promiseHandler 18 | 19 | • **errorHandler?**: `any` 20 | 21 | errorHandler 22 | 23 | ## Returns 24 | 25 | `Promise`\<`any`\> 26 | 27 | ## Example 28 | 29 | ```ts 30 | new catchPromise(resolve, reject, rejectHandler); /// Promise 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/functions/checkFileExt.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / checkFileExt 6 | 7 | # Function: checkFileExt() 8 | 9 | > **checkFileExt**(`arr`, `value`): `boolean` 10 | 11 | 检查是否为 file.ext string 文件扩展名 12 | 13 | ## Parameters 14 | 15 | • **arr**: `string`[] 16 | 17 | • **value**: `string` 18 | 19 | 字符串值 20 | 21 | ## Returns 22 | 23 | `boolean` 24 | 25 | ## Example 26 | 27 | ```ts 28 | checkFileExt(['png', 'jpg'], 'test.jpg'); /// true 29 | checkFileExt(['png', 'jpg'], 'test.JPG'); /// true 30 | checkFileExt(['png', 'jpg'], 'test.jpg.txt'); /// false 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/functions/checkIdCard.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / checkIdCard 6 | 7 | # Function: checkIdCard() 8 | 9 | > **checkIdCard**(`value`): `boolean` 10 | 11 | 检查是否为 idCard string 身份证 12 | 支持 15 、 18 位 13 | 14 | ## Parameters 15 | 16 | • **value**: `string` 17 | 18 | 字符串值 19 | 20 | ## Returns 21 | 22 | `boolean` 23 | 24 | ## Example 25 | 26 | ```ts 27 | checkIdCard('350424870506202'); /// true 28 | checkIdCard('003424870506202'); /// false 29 | checkIdCard('415106199801012130'); /// true 30 | checkIdCard('123123123123123222'); /// false 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/functions/checkPassWordLevel.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / checkPassWordLevel 6 | 7 | # Function: checkPassWordLevel() 8 | 9 | > **checkPassWordLevel**(`passWord`): `-1` \| `1` \| `2` \| `3` \| `4` \| `5` 10 | 11 | 密码强度等级检测(-1~5) 12 | 13 | ## Parameters 14 | 15 | • **passWord**: `string` 16 | 17 | 字符串值-密码 18 | 19 | ## Returns 20 | 21 | `-1` \| `1` \| `2` \| `3` \| `4` \| `5` 22 | 23 | ## Example 24 | 25 | ```ts 26 | checkPassWordLevel('123'); /// -1 27 | checkPassWordLevel('123456'); /// 1 28 | checkPassWordLevel('12345678'); /// 2 29 | checkPassWordLevel('12345678.'); /// 3 30 | checkPassWordLevel('123456789654321.'); /// 4 31 | checkPassWordLevel('123456789654321.H'); /// 5 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/checkVersion.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / checkVersion 6 | 7 | # Function: checkVersion() 8 | 9 | > **checkVersion**(`targetVersion`, `currentVersion`, `testStr`): `-1` \| `1` \| `0` 10 | 11 | 版本号比对算法 12 | 13 | ## Parameters 14 | 15 | • **targetVersion**: `string` 16 | 17 | 目标版本 18 | 19 | • **currentVersion**: `string` 20 | 21 | 当前版本 22 | 23 | • **testStr**: `string` = `'-rc'` 24 | 25 | 需要替换的字符串 default(-rc) 26 | 27 | ## Returns 28 | 29 | `-1` \| `1` \| `0` 30 | 31 | ## Example 32 | 33 | ```ts 34 | checkVersion('1.0.1-rc', '1.0.0', '-rc'); /// 1 35 | checkVersion('1.0.0', '1.0.1'); /// -1 36 | checkVersion('1.0.0', '1.0.0'); /// 0 37 | ``` 38 | -------------------------------------------------------------------------------- /docs/functions/clearCookies.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / clearCookies 6 | 7 | # Function: clearCookies() 8 | 9 | > **clearCookies**(): `void` 10 | 11 | Clear Cookie 12 | 13 | ## Returns 14 | 15 | `void` 16 | 17 | ## Example 18 | 19 | ```ts 20 | clearCookies(); /// 删除所有的 Cookie 21 | ``` 22 | -------------------------------------------------------------------------------- /docs/functions/clearObject.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / clearObject 6 | 7 | # Function: clearObject() 8 | 9 | > **clearObject**(`obj`, `replacement`?): `object` 10 | 11 | 清理对象中的空值，将 `null` 和 `undefined` 删除或替换。 12 | 13 | ## Parameters 14 | 15 | • **obj**: `any` 16 | 17 | 需要清理的对象 18 | 19 | • **replacement?**: `any` 20 | 21 | 替换值，默认为 `undefined`，如果传入值则替换为该值。 22 | 23 | ## Returns 24 | 25 | `object` 26 | 27 | ## Example 28 | 29 | ```ts 30 | clearObject({ a: 1, b: null, c: undefined, d: '', e: ' ' }); /// 返回: { a: 1 } 31 | clearObject({ a: 1, b: null, c: undefined, d: '', e: ' ' }, ''); /// 返回: { a: 1, b: '', c: '', d: '', e: '' } 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/closeFullscreen.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / closeFullscreen 6 | 7 | # Function: closeFullscreen() 8 | 9 | > **closeFullscreen**(): `void` 10 | 11 | 关闭全屏 12 | 13 | ## Returns 14 | 15 | `void` 16 | 17 | ## Example 18 | 19 | ```ts 20 | closeFullscreen(); /// 关闭全屏 21 | ``` 22 | -------------------------------------------------------------------------------- /docs/functions/closeWebSocket.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / closeWebSocket 6 | 7 | # Function: closeWebSocket() 8 | 9 | > **closeWebSocket**(): `boolean` 10 | 11 | 关闭 websocket 12 | 13 | ## Returns 14 | 15 | `boolean` 16 | 17 | ## Example 18 | 19 | ```ts 20 | closeWebSocket(); /// true/false 21 | ``` 22 | -------------------------------------------------------------------------------- /docs/functions/compareDate.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / compareDate 6 | 7 | # Function: compareDate() 8 | 9 | > **compareDate**(`dateA`, `dateB`?): `-1` \| `1` \| `0` 10 | 11 | 时间大小比较 12 | -1(AB), 0(A=B) 13 | 14 | ## Parameters 15 | 16 | • **dateA**: `any` 17 | 18 | 时间 A 19 | 20 | • **dateB?**: `any` 21 | 22 | 时间 B 23 | 24 | ## Returns 25 | 26 | `-1` \| `1` \| `0` 27 | 28 | ## Example 29 | 30 | ```ts 31 | compareDate('2023-1-1'); /// 1 32 | compareDate('2023-1-1 12:00:00', '2023-1-2 12:00:00'); /// -1 33 | ``` 34 | -------------------------------------------------------------------------------- /docs/functions/copyToClipboard.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / copyToClipboard 6 | 7 | # Function: copyToClipboard() 8 | 9 | > **copyToClipboard**(`text`): `void` 10 | 11 | 复制到剪贴板 12 | 13 | ## Parameters 14 | 15 | • **text**: `string` 16 | 17 | 内容文本 18 | 19 | ## Returns 20 | 21 | `void` 22 | 23 | ## Example 24 | 25 | ```ts 26 | copyToClipboard('hello world') 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/countdown.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / countdown 6 | 7 | # Function: countdown() 8 | 9 | > **countdown**(`seconds`, `callback`?, `finishCallBack`?): `any` 10 | 11 | 倒计时 12 | 13 | ## Parameters 14 | 15 | • **seconds**: `number` 16 | 17 | 秒数 18 | 19 | • **callback?**: `any` 20 | 21 | 回调函数 22 | 23 | • **finishCallBack?**: `any` 24 | 25 | 完成回调函数 26 | 27 | ## Returns 28 | 29 | `any` 30 | 31 | ## Example 32 | 33 | ```ts 34 | console.time('test'); countdown(10, (x) => console.log('--->', x), () => console.timeEnd('test')); /// test: 10023.636962890625 ms 35 | ``` 36 | -------------------------------------------------------------------------------- /docs/functions/createChangeLogListener.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / createChangeLogListener 6 | 7 | # Function: createChangeLogListener() 8 | 9 | > **createChangeLogListener**(`callback`?): () => `void` 10 | 11 | 创建全局 change 事件埋点与回调，也可使用 `emitEvent` 主动触发。 12 | 13 | ## Parameters 14 | 15 | • **callback?**: `any` 16 | 17 | 监听 Track 回调 18 | 19 | ## Returns 20 | 21 | `Function` 22 | 23 | ### Returns 24 | 25 | `void` 26 | 27 | ## Example 28 | 29 | ```ts 30 | const cancel = createChangeLogListener((event, key, data) => console.log({ event, key, data })); /// 页面加载完成后创建监听器，取消监听器 cancel(); 。 31 |
/// 父元素总监听 32 | /// 普通监听 33 | ``` 34 | -------------------------------------------------------------------------------- /docs/functions/curryIt.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / curryIt 6 | 7 | # Function: curryIt() 8 | 9 | > **curryIt**(`fn`): (...`args`) => `any` 10 | 11 | -函数柯里化- 12 | 是把接受多个参数的函数变换成接受一个单一参数(最初函数的第一个参数)的函数，并且返回接受余下的参数且返回结果的新函数的技术。 13 | 14 | ## Parameters 15 | 16 | • **fn**: `any` 17 | 18 | 函数 19 | 20 | ## Returns 21 | 22 | `Function` 23 | 24 | ### Parameters 25 | 26 | • ...**args**: `any`[] 27 | 28 | ### Returns 29 | 30 | `any` 31 | 32 | ## Example 33 | 34 | ```ts 35 | curryIt(function (a, b, c) {return a + b + c})(1)(2)(3); /// 6 36 | ``` 37 | -------------------------------------------------------------------------------- /docs/functions/customFinally.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / customFinally 6 | 7 | # Function: customFinally() 8 | 9 | > **customFinally**(`promise`, `onFinally`?): `Promise`\<`any`\> 10 | 11 | 自定义封装 Promise 的 finally 方法，小程序使用。 12 | 13 | ## Parameters 14 | 15 | • **promise**: `Promise`\<`any`\> 16 | 17 | 要封装的 Promise 对象 18 | 19 | • **onFinally?**: `any` 20 | 21 | finally 回调函数 (可选) 22 | 23 | ## Returns 24 | 25 | `Promise`\<`any`\> 26 | 27 | ## Example 28 | 29 | ```ts 30 | customFinally(Promise.resolve(1), () => console.log(1)); /// finally 回调 31 | // 也可挂载在 Promise 原型上 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/cx.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / cx 6 | 7 | # Function: cx() 8 | 9 | > **cx**(...`classNames`): `string` 10 | 11 | 合并类名 emotion-js 12 | 13 | ## Parameters 14 | 15 | • ...**classNames**: `any`[] 16 | 17 | 要合并的类名、对象或空值 18 | 19 | ## Returns 20 | 21 | `string` 22 | 23 | ## Example 24 | 25 | ```ts 26 | cx('class1', 'class2', { 'class3': true, 'class4': false }, null, undefined); /// "class1 class2 class3" 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/data2Arr.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / data2Arr 6 | 7 | # Function: data2Arr() 8 | 9 | > **data2Arr**(`sourceData`, `key`): `any`[] 10 | 11 | 数组对象转数组值 12 | 13 | ## Parameters 14 | 15 | • **sourceData**: `object`[] 16 | 17 | 源数据 18 | 19 | • **key**: `string` 20 | 21 | 取值的 key 22 | 23 | ## Returns 24 | 25 | `any`[] 26 | 27 | ## Example 28 | 29 | ```ts 30 | data2Arr([{a: 1, b: 2}, {a: 3}, {b: 1}], 'a'); /// [1, 3] 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/functions/data2Obj.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / data2Obj 6 | 7 | # Function: data2Obj() 8 | 9 | > **data2Obj**(`sourceData`, `key`, `vKey`?): `object` 10 | 11 | 数组对象转对象，按照指定的 key 分组。 12 | 13 | ## Parameters 14 | 15 | • **sourceData**: `object`[] 16 | 17 | 源数据 18 | 19 | • **key**: `string` 20 | 21 | 分组的 key 22 | 23 | • **vKey?**: `string` 24 | 25 | 值的 key，默认为整个值。 26 | 27 | ## Returns 28 | 29 | `object` 30 | 31 | ## Example 32 | 33 | ```ts 34 | data2Obj([{a: 1, b: 2}, {a: 3}, {b: 1}, {c: 1}], 'a'); /// {1: {a: 1, b: 2}, 3: {a: 3}, undefined: {c: 1}} 35 | data2Obj([{a: 1, b: 'b1'}, {a: 3}, {a: 2, b: 'b2'}], 'a', 'b'); /// { '1': 'b1', '2': 'b2', '3': undefined } 36 | ``` 37 | -------------------------------------------------------------------------------- /docs/functions/dataTo.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / dataTo 6 | 7 | # Function: dataTo() 8 | 9 | > **dataTo**(`key`, `value`): `void` 10 | 11 | 填对应值到对应的 dom 中 12 | 13 | ## Parameters 14 | 15 | • **key**: `string` 16 | 17 | key 值 18 | 19 | • **value**: `any` 20 | 21 | value 值 22 | 23 | ## Returns 24 | 25 | `void` 26 | 27 | ## Example 28 | 29 | ```ts 30 | dataTo('.className', 'xxx'); /// xxx 会填入到类名为 class-name 的元素中 31 | dataTo('.class-name', 'xxx'); /// xxx 会填入到类名为 class-name 的元素中 32 | dataTo('.class_name', 'xxx'); /// xxx 会填入到类名为 class-name 的元素中 33 | dataTo('.class.name', 'xxx'); /// xxx 会填入到类名为 class-name 的元素中 34 | dataTo('#id.name', 'xxx'); /// xxx 会填入到 id 名为 id-name 的元素中 35 | ``` 36 | -------------------------------------------------------------------------------- /docs/functions/debounce.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / debounce 6 | 7 | # Function: debounce() 8 | 9 | > **debounce**(`fn`, `delay`): () => `void` 10 | 11 | 防抖函数-最后一次有效（抢购） 12 | 13 | ## Parameters 14 | 15 | • **fn**: `any` 16 | 17 | 执行的函数 18 | 19 | • **delay**: `number` = `1000` 20 | 21 | 延迟时间 22 | 23 | ## Returns 24 | 25 | `Function` 26 | 27 | ### Returns 28 | 29 | `void` 30 | 31 | ## Example 32 | 33 | ```ts 34 | debounce(() => {}, 1000); /// 防抖执行 35 | ``` 36 | -------------------------------------------------------------------------------- /docs/functions/decrypt.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / decrypt 6 | 7 | # Function: decrypt() 8 | 9 | > **decrypt**(`dataStr`, `jsonDecode`, `secretKey`?, `secretIv`?): `string` 10 | 11 | 解密函数 12 | 防君子不防小人，也可以通过后台获取密钥。 13 | 14 | ## Parameters 15 | 16 | • **dataStr**: `string` 17 | 18 | 加密后的字符串 19 | 20 | • **jsonDecode**: `boolean` = `false` 21 | 22 | 是否需要解析成 json 23 | 24 | • **secretKey?**: `string` 25 | 26 | [可选] 十六位十六进制数作为密钥 27 | 28 | • **secretIv?**: `string` 29 | 30 | [可选] 十六位十六进制数作为密钥偏移量 31 | 32 | ## Returns 33 | 34 | `string` 35 | 36 | ## Example 37 | 38 | ```ts 39 | decrypt("加密后的字符串"); /// 解密后的字符串 40 | decrypt("加密后的字符串", true); /// 解密后的字符串并转换为 JSON 对象 41 | decrypt("加密后的字符串", "1234567887654321","1234567887654321"); /// 自定义密钥解密后的字符串 42 | ``` 43 | -------------------------------------------------------------------------------- /docs/functions/deepClone.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / deepClone 6 | 7 | # Function: deepClone() 8 | 9 | > **deepClone**(`data`, `hash`): `any` 10 | 11 | 深拷贝 12 | 13 | ## Parameters 14 | 15 | • **data**: `any` 16 | 17 | 源数据 18 | 19 | • **hash**: `WeakMap`\<`object`, `any`\> = `...` 20 | 21 | hash 存储，避免循环引用。 22 | 23 | ## Returns 24 | 25 | `any` 26 | 27 | ## Link 28 | 29 | https://juejin.cn/post/7075351322014253064 30 | 31 | ## Example 32 | 33 | ```ts 34 | deepClone({a: 1, b: {c: 2}}); /// 新的 {a: 1, b: {c: 2}} 35 | ``` 36 | -------------------------------------------------------------------------------- /docs/functions/difference.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / difference 6 | 7 | # Function: difference() 8 | 9 | > **difference**(`paramA`, `paramB`): `any` 10 | 11 | 获取数组或对象不同值集合 12 | 13 | ## Parameters 14 | 15 | • **paramA**: `any` 16 | 17 | 值 A，若冲突以此值为准。 18 | 19 | • **paramB**: `any` 20 | 21 | 值 B 22 | 23 | ## Returns 24 | 25 | `any` 26 | 27 | ## Example 28 | 29 | ```ts 30 | difference([1, 2, 2, 3, 3], [1, 2, 4, 5]); /// [3] 31 | difference({a: 1, b: 2}, {a: 1, c: 3, b: 4}); /// {b: 2} 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/disableConflictEvent.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / disableConflictEvent 6 | 7 | # Function: disableConflictEvent() 8 | 9 | > **disableConflictEvent**(`event`): `boolean` 10 | 11 | 禁用冲突事件，条码枪、关闭窗口快捷键等。 12 | 13 | ## Parameters 14 | 15 | • **event**: `any` 16 | 17 | 触发事件 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | document.addEventListener('keydown', disableConflictEvent); /// 进入页面后禁用冲突事件 27 | document.removeEventListener('keydown', disableConflictEvent); /// 退出页面后关闭监听 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/div.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / div 6 | 7 | # Function: div() 8 | 9 | > **div**(`div1`, `div2`): `number` 10 | 11 | 除法函数 12 | 13 | ## Parameters 14 | 15 | • **div1**: `string` \| `number` 16 | 17 | 被除数 18 | 19 | • **div2**: `string` \| `number` 20 | 21 | 除数 22 | 23 | ## Returns 24 | 25 | `number` 26 | 27 | ## Example 28 | 29 | ```ts 30 | div(1, 2); /// 0.5 31 | div(0.55, 100); /// 0.0055 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/download.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / download 6 | 7 | # Function: download() 8 | 9 | > **download**(`link`, `name`): `void` 10 | 11 | 下载一个链接文档 12 | 13 | ## Parameters 14 | 15 | • **link**: `string` 16 | 17 | 链接 18 | 19 | • **name**: `string` 20 | 21 | 文件名称(可选，默认以链接最好一段作为名称，填写时可不带后缀自动识别，写了后缀会以写的后缀为准。) 22 | 23 | ## Returns 24 | 25 | `void` 26 | 27 | ## Example 28 | 29 | ```ts 30 | download('https://xxx.com/xxx', 'xxx'); /// 下载后端返回的流 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/functions/downloadContent.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / downloadContent 6 | 7 | # Function: downloadContent() 8 | 9 | > **downloadContent**(`name`, `content`): `void` 10 | 11 | 在浏览器中自定义下载一些内容，与 download 不同的是，downloadContent 采用 Blob 可能会有长度限制。 12 | 13 | ## Parameters 14 | 15 | • **name**: `string` 16 | 17 | 文件名称(需带后缀)，默认 txt 。 18 | 19 | • **content**: `any` 20 | 21 | 内容 BlobPart | any 22 | 23 | ## Returns 24 | 25 | `void` 26 | 27 | ## Example 28 | 29 | ```ts 30 | downloadContent('test.txt', 'test txt content'); /// 下载返回的流 31 | downloadContent('test.json', JSON.stringify({content: 'test json'})); /// 下载返回的流 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/emitEvent.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / emitEvent 6 | 7 | # Function: emitEvent() 8 | 9 | > **emitEvent**(`eventType`, `eventDetail`?, `element`?): `void` 10 | 11 | 触发元素事件 12 | 13 | ## Parameters 14 | 15 | • **eventType**: `string` = `'click'` 16 | 17 | 事件类型，默认为 'click' 。 18 | 19 | • **eventDetail?**: `any` 20 | 21 | 事件自定义参数可以为空。不为空触发 CustomEvent 。 22 | 23 | • **element?**: `null` \| `HTMLElement` = `document.body` 24 | 25 | 目标元素，默认为 document.body ，支持传 document 。 26 | 27 | ## Returns 28 | 29 | `void` 30 | 31 | ## Example 32 | 33 | ```ts 34 | emitEvent('click', null, document.getElementById('myButton')); // 触发元素点击事件 35 | emitEvent('click', { logKey: 'test', params: { hello: 'world' } }); // 触发自定义元素点击事件 36 | ``` 37 | -------------------------------------------------------------------------------- /docs/functions/empty.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / empty 6 | 7 | # Function: empty() 8 | 9 | > **empty**(`variable`): `boolean` 10 | 11 | 判断值是否为空 12 | 13 | ## Parameters 14 | 15 | • **variable**: `any` 16 | 17 | 变量 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | empty(''); /// true 27 | empty(null); /// true 28 | empty('null'); /// true 29 | empty('undefined'); /// true 30 | empty(undefined); /// true 31 | empty(0); /// false 32 | empty('0'); /// false 33 | empty(NaN); /// true 34 | empty('NaN'); /// true 35 | empty({}); /// true 36 | empty([]); /// true 37 | ``` 38 | -------------------------------------------------------------------------------- /docs/functions/encrypt.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / encrypt 6 | 7 | # Function: encrypt() 8 | 9 | > **encrypt**(`data`, `secretKey`?, `secretIv`?): `string` 10 | 11 | 加密函数 12 | 防君子不防小人，也可以通过后台获取密钥。 13 | 14 | ## Parameters 15 | 16 | • **data**: `any` 17 | 18 | 需要加密的数据 19 | 20 | • **secretKey?**: `string` 21 | 22 | [可选] 十六位十六进制数作为密钥 23 | 24 | • **secretIv?**: `string` 25 | 26 | [可选] 十六位十六进制数作为密钥偏移量 27 | 28 | ## Returns 29 | 30 | `string` 31 | 32 | ## Example 33 | 34 | ```ts 35 | encrypt("value"); /// 加密后的字符串 36 | encrypt("value", "1234567887654321","1234567887654321"); /// 自定义密钥加密后的字符串 37 | ``` 38 | -------------------------------------------------------------------------------- /docs/functions/every.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / every 6 | 7 | # Function: every() 8 | 9 | > **every**(`collection`, `callback`?): `boolean` 10 | 11 | every 函数 12 | 因为默认的 every 空数组会返回 true 13 | 14 | ## Parameters 15 | 16 | • **collection**: `any` 17 | 18 | 源数据 19 | 20 | • **callback?**: `any` 21 | 22 | 回调 23 | 24 | ## Returns 25 | 26 | `boolean` 27 | 28 | ## Example 29 | 30 | ```ts 31 | every([]); /// false 32 | every([1, 2, 3], (item) => item > 0); /// true 33 | every({}); /// false 34 | every(undefined); /// false 35 | ``` 36 | -------------------------------------------------------------------------------- /docs/functions/exportFile.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / exportFile 6 | 7 | # Function: exportFile() 8 | 9 | > **exportFile**(`data`, `fileName`?, `fileType`?): `void` 10 | 11 | 导出数据为文件 12 | 13 | ## Parameters 14 | 15 | • **data**: `string` 16 | 17 | 数据 18 | 19 | • **fileName?**: `string` 20 | 21 | 文件名 22 | 23 | • **fileType?**: `string` = `'txt'` 24 | 25 | 文件类型 26 | 27 | ## Returns 28 | 29 | `void` 30 | 31 | ## Example 32 | 33 | ```ts 34 | exportFile(data); /// 导出 txt 文件 35 | exportFile(data, 'csv-导出文件测试', 'csv'); /// 导出 csv 文件 36 | exportFile(document.getElementById('table_to_xls').outerHTML, 'excelWithStyle', 'xls'); /// 导出表格为带样式的 excel xls 文件 37 | exportFile('http://a.biugle.cn/img/cdn/dev/avatar/1.png', 'test', 'png'); /// 导出 png 文件 38 | ``` 39 | -------------------------------------------------------------------------------- /docs/functions/filterTreeData.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / filterTreeData 6 | 7 | # Function: filterTreeData() 8 | 9 | > **filterTreeData**(`treeData`, `callback`?): `any`[] 10 | 11 | 获取筛选后的树数据，自定义方法。 12 | 13 | ## Parameters 14 | 15 | • **treeData**: `any`[] 16 | 17 | 树值 18 | 19 | • **callback?** 20 | 21 | 过滤的方法，默认不过滤。 22 | 23 | ## Returns 24 | 25 | `any`[] 26 | 27 | ## Example 28 | 29 | ```ts 30 | filterTreeData(treeData, (item) => item); /// ... 31 | filterTreeData(treeData, (item) => filterIds.includes(item.id)); /// ... 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/findChildren.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / findChildren 6 | 7 | # Function: findChildren() 8 | 9 | > **findChildren**(`element`): `any`[] 10 | 11 | 找元素的所有子元素，解决浏览器兼容问题。 12 | 13 | ## Parameters 14 | 15 | • **element**: `any` 16 | 17 | 指定元素 18 | 19 | ## Returns 20 | 21 | `any`[] 22 | 23 | ## Example 24 | 25 | ```ts 26 | findChildren(document.getElementById('test')); /// #test 的所有子元素数组 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/findMaxKey.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / findMaxKey 6 | 7 | # Function: findMaxKey() 8 | 9 | > **findMaxKey**(`objArray`): `never`[] 10 | 11 | 找到对象数组具有最多 key 的对象，并返回其 key 组成的数组。 12 | 13 | ## Parameters 14 | 15 | • **objArray**: `any`[] 16 | 17 | 源数据 18 | 19 | ## Returns 20 | 21 | `never`[] 22 | 23 | ## Example 24 | 25 | ```ts 26 | const objects = [ 27 | { id: 1, name: 'a', age: 25 }, 28 | { id: 2, name: 'b', age: 30, city: '123' }, 29 | { id: 3, name: 'c', age: 35, city: '456', profession: 'Engineer' } 30 | ]; 31 | findMaxKey(objects); /// ['id', 'name', 'age', 'city', 'profession'] 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/findParents.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / findParents 6 | 7 | # Function: findParents() 8 | 9 | > **findParents**(`element`, `n`): `any` 10 | 11 | 找元素的第 n 级父元素 12 | 13 | ## Parameters 14 | 15 | • **element**: `any` 16 | 17 | 指定元素 18 | 19 | • **n**: `number` 20 | 21 | 第几个 22 | 23 | ## Returns 24 | 25 | `any` 26 | 27 | ## Example 28 | 29 | ```ts 30 | findParents(document.getElementById('test'), 3); /// #test 的第三个父元素 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/functions/float.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / float 6 | 7 | # Function: float() 8 | 9 | > **float**(`value`, `d`, `isStr`): `number` \| `string` 10 | 11 | 去尾法获取数值 12 | 13 | ## Parameters 14 | 15 | • **value**: `number` 16 | 17 | 数值 18 | 19 | • **d**: `number` = `0` 20 | 21 | 精度 22 | 23 | • **isStr**: `boolean` = `false` 24 | 25 | 是否返回字符串 26 | 27 | ## Returns 28 | 29 | `number` \| `string` 30 | 31 | ## Example 32 | 33 | ```ts 34 | float(1.135, 0, true); /// '1' 35 | float(1.135, 2, true); /// '1.13' 36 | float(1.135, 1); /// 1.1 37 | float(1.135, 4); /// 1.135 38 | float(1.135, 4, true); /// '1.1350' 39 | ``` 40 | -------------------------------------------------------------------------------- /docs/functions/forEach.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / forEach 6 | 7 | # Function: forEach() 8 | 9 | > **forEach**(`data`, `callback`, `hasReturn`): `any` 10 | 11 | 遍历数组或对象，并对每个元素执行回调函数，支持中途 break 和 continue 。 12 | 13 | ## Parameters 14 | 15 | • **data**: `any` 16 | 17 | 要遍历的数据，可以是数组或对象。 18 | 19 | • **callback** 20 | 21 | 回调函数 22 | 23 | • **hasReturn**: `boolean` = `false` 24 | 25 | 是否返回一个新值 26 | 27 | ## Returns 28 | 29 | `any` 30 | 31 | ## Example 32 | 33 | ```ts 34 | forEach([1, 2, 3], (item, index) => console.log(item, index)); 35 | forEach([1, 2, 3], (item, index) => item * 2, true); /// [2, 4, 6] 36 | forEach({a: 1, b: 2}, (value, key) => console.log(value, key)); 37 | forEach({a: 1, b: 2}, (value, key) => value * 2, true); /// {a: 2, b: 4} 38 | ``` 39 | -------------------------------------------------------------------------------- /docs/functions/forceToStr.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / forceToStr 6 | 7 | # Function: forceToStr() 8 | 9 | > **forceToStr**(`value`, `defaultValue`): `string` 10 | 11 | 强制转化为字符串，避免导出表格显示科学计数法。 12 | 13 | ## Parameters 14 | 15 | • **value**: `any` 16 | 17 | 值 18 | 19 | • **defaultValue**: `string` = `'-'` 20 | 21 | 默认值 22 | 23 | ## Returns 24 | 25 | `string` 26 | 27 | ## Example 28 | 29 | ```ts 30 | forceToStr(123123123); /// '123123123' 31 | forceToStr(undefined); /// '-' 32 | forceToStr(undefined, 0); /// '0' 33 | ``` 34 | -------------------------------------------------------------------------------- /docs/functions/formatBytes.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / formatBytes 6 | 7 | # Function: formatBytes() 8 | 9 | > **formatBytes**(`bytes`, `precision`): `string` 10 | 11 | 文件大小格式化 12 | 13 | ## Parameters 14 | 15 | • **bytes**: `number` 16 | 17 | 文件大小 bytes 18 | 19 | • **precision**: `number` = `2` 20 | 21 | 精度 22 | 23 | ## Returns 24 | 25 | `string` 26 | 27 | ## Example 28 | 29 | ```ts 30 | formatBytes(1024); /// '1.00 KB' 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/functions/formatDate.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / formatDate 6 | 7 | # Function: formatDate() 8 | 9 | > **formatDate**(`date`?, `fmt`?, `weeks`?): `any` 10 | 11 | 时间格式化 12 | 13 | ## Parameters 14 | 15 | • **date?**: `any` 16 | 17 | 时间 18 | 19 | • **fmt?**: `string` = `'yyyy-mm-dd hh:ii:ss'` 20 | 21 | 格式化模板 'yyyy-mm-dd hh:ii:ss' 22 | 23 | • **weeks?**: `any`[] = `...` 24 | 25 | 星期对应数组 [7, 1, 2, 3, 4, 5, 6] 26 | 27 | ## Returns 28 | 29 | `any` 30 | 31 | ## Example 32 | 33 | ```ts 34 | formatDate(new Date(), 'yyyy-mm-dd hh:ii:ss Q S W', ['星期天', '星期一', '星期二', '星期三', '星期四', '星期五', '星期六']); /// '2022-04-26 11:33:53 2 123 星期二' 35 | // @before-2.2.0 36 | formatDate(); /// '当前时间 yyyy-mm-dd hh:ii:ss' 37 | // @since-2.2.0 38 | formatDate(); /// undefined 39 | ``` 40 | -------------------------------------------------------------------------------- /docs/functions/formatJSON.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / formatJSON 6 | 7 | # Function: formatJSON() 8 | 9 | > **formatJSON**(`value`): `string` 10 | 11 | 格式化 JSON 字符串 12 | 13 | ## Parameters 14 | 15 | • **value**: `any` 16 | 17 | 值 18 | 19 | ## Returns 20 | 21 | `string` 22 | 23 | ## Example 24 | 25 | ```ts 26 | formatJSON({ a: 123, b: 456 }); /// '{\n "a": 123,\n "b": 456\n}' 27 | formatJSON('123'); /// '"123"' 28 | formatJSON(123); /// '123' 29 | formatJSON(null); /// 'null' 30 | formatJSON(true); /// 'true' 31 | formatJSON(undefined); /// 'undefined' 32 | formatJSON(new Date()); /// '"2023-03-02T10:02:42.019Z"' 33 | ``` 34 | -------------------------------------------------------------------------------- /docs/functions/formatNumber.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / formatNumber 6 | 7 | # Function: formatNumber() 8 | 9 | > **formatNumber**(`value`, `n`): `string` 10 | 11 | 数字人性化显示 12 | 13 | ## Parameters 14 | 15 | • **value**: `string` \| `number` 16 | 17 | 数值 18 | 19 | • **n**: `number` = `2` 20 | 21 | 精度 22 | 23 | ## Returns 24 | 25 | `string` 26 | 27 | ## Example 28 | 29 | ```ts 30 | formatNumber('12312300'); /// '12,312,300' 31 | formatNumber(851232.1314); /// '851,232.13' 32 | formatNumber(851232.1314, 0); /// '851,232' 33 | ``` 34 | -------------------------------------------------------------------------------- /docs/functions/getAge.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getAge 6 | 7 | # Function: getAge() 8 | 9 | > **getAge**(`birthday`, `targetDate`?): `number` 10 | 11 | 获取年龄 12 | 13 | ## Parameters 14 | 15 | • **birthday**: `any` 16 | 17 | 生日 18 | 19 | • **targetDate?**: `any` 20 | 21 | 目标日期 22 | 23 | ## Returns 24 | 25 | `number` 26 | 27 | ## Example 28 | 29 | ```ts 30 | getAge('1998-9-28'); /// 24 31 | getAge('1998-6-8', '2023-7'); /// 25 32 | getAge('2023'); /// -1 33 | ``` 34 | -------------------------------------------------------------------------------- /docs/functions/getAnimal.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getAnimal 6 | 7 | # Function: getAnimal() 8 | 9 | > **getAnimal**(`date`): `string` 10 | 11 | 获取生肖 12 | 13 | ## Parameters 14 | 15 | • **date**: `any` 16 | 17 | 日期 18 | 19 | ## Returns 20 | 21 | `string` 22 | 23 | ## Example 24 | 25 | ```ts 26 | getAnimal('1998'); /// '虎' 27 | getAnimal('1998-6-8'); /// '虎' 28 | getAnimal('2023'); /// '兔' 29 | ``` 30 | -------------------------------------------------------------------------------- /docs/functions/getBSColor.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getBSColor 6 | 7 | # Function: getBSColor() 8 | 9 | > **getBSColor**(`key`): `string` 10 | 11 | 获取 bootstrap 颜色 12 | 13 | ## Parameters 14 | 15 | • **key**: `string` = `'default'` 16 | 17 | color name 18 | 19 | ## Returns 20 | 21 | `string` 22 | 23 | ## Example 24 | 25 | ```ts 26 | getBSColor(); /// '#6c757d' 27 | getBSColor('red'); /// '#dc3545' 28 | getBSColor('warning'); /// '#ffc107' 29 | ``` 30 | -------------------------------------------------------------------------------- /docs/functions/getBaseURL.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getBaseURL 6 | 7 | # Function: getBaseURL() 8 | 9 | > **getBaseURL**(`url`?, `hashRoute`?): `string` 10 | 11 | 获取不带任何参数或片段标识符的当前 URL 12 | 13 | ## Parameters 14 | 15 | • **url?**: `string` 16 | 17 | 地址/链接 18 | 19 | • **hashRoute?**: `boolean` = `false` 20 | 21 | 是否为 hash 路由，默认为 false 。 22 | 23 | ## Returns 24 | 25 | `string` 26 | 27 | ## Example 28 | 29 | ```ts 30 | getBaseURL('https://test.com/index?name=leo&org=biugle#test'); /// 'https://test.com/index' 31 | getBaseURL(''); /// '' 32 | getBaseURL(); /// 当前页面 BaseURL 33 | getBaseURL('https://test.com/#/test?name=leo&org=biugle', true); /// 'https://test.com/#/test' 34 | getBaseURL(null); /// 相当于 window.location.origin 35 | ``` 36 | -------------------------------------------------------------------------------- /docs/functions/getBloodGroup.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getBloodGroup 6 | 7 | # Function: getBloodGroup() 8 | 9 | > **getBloodGroup**(`bloodGroup`): `object` 10 | 11 | 获取血型枚举信息 12 | 13 | ## Parameters 14 | 15 | • **bloodGroup**: `string` 16 | 17 | 血型 18 | 19 | ## Returns 20 | 21 | `object` 22 | 23 | ### color 24 | 25 | > **color**: `string` 26 | 27 | ### label 28 | 29 | > **label**: `string` 30 | 31 | ### lower 32 | 33 | > **lower**: `string` 34 | 35 | ### upper 36 | 37 | > **upper**: `string` 38 | 39 | ### value 40 | 41 | > **value**: `string` 42 | 43 | ## Example 44 | 45 | ```ts 46 | getBloodGroup('A'); /// { value: 'A', label: 'A 型', color: '#1890FF', lower: 'a', upper: 'A' } 47 | ``` 48 | -------------------------------------------------------------------------------- /docs/functions/getConstellation.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getConstellation 6 | 7 | # Function: getConstellation() 8 | 9 | > **getConstellation**(`date`): `object` 10 | 11 | 获取星座 12 | 13 | ## Parameters 14 | 15 | • **date**: `any` 16 | 17 | 日期 18 | 19 | ## Returns 20 | 21 | `object` 22 | 23 | ### cn 24 | 25 | > **cn**: `string` 26 | 27 | ### date 28 | 29 | > **date**: `any` 30 | 31 | ### en 32 | 33 | > **en**: `string` 34 | 35 | ## Example 36 | 37 | ```ts 38 | getConstellation('11-24'); /// { cn: '射手', en: 'Sagittarius', date: '11.23-12.21' } 39 | getConstellation('xxx'); /// {cn: '未知', en: 'unknown', date: 'xxx'} 40 | getConstellation(new Date('2022-11-24')); /// { cn: '射手', en: 'Sagittarius', date: '11.23-12.21' } 41 | ``` 42 | -------------------------------------------------------------------------------- /docs/functions/getContentType.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getContentType 6 | 7 | # Function: getContentType() 8 | 9 | > **getContentType**(`fileType`): `string` 10 | 11 | 获取常见的 content-type 12 | 13 | ## Parameters 14 | 15 | • **fileType**: `string` 16 | 17 | 文件类型 18 | 19 | ## Returns 20 | 21 | `string` 22 | 23 | ## Example 24 | 25 | ```ts 26 | getContentType('form'); /// 'application/x-www-form-urlencoded' 27 | getContentType('file'); /// 'multipart/form-data' 28 | getContentType('pdf'); /// 'application/pdf' 29 | getContentType('PDF'); /// 'application/pdf' 30 | getContentType('unknown'); /// 'application/octet-stream' 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/functions/getCookie.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getCookie 6 | 7 | # Function: getCookie() 8 | 9 | > **getCookie**(`key`): `any` 10 | 11 | Get Cookie 12 | 13 | ## Parameters 14 | 15 | • **key**: `string` 16 | 17 | Cookie key 18 | 19 | ## Returns 20 | 21 | `any` 22 | 23 | ## Example 24 | 25 | ```ts 26 | getCookie('name'); /// 获取 name 对应的 Cookie 值 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/getCryptoJS.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getCryptoJS 6 | 7 | # Function: getCryptoJS() 8 | 9 | > **getCryptoJS**(): *typeof* `CryptoJS` 10 | 11 | 获取 CryptoJS 12 | 13 | ## Returns 14 | 15 | *typeof* `CryptoJS` 16 | 17 | ## Example 18 | 19 | ```ts 20 | getCryptoJS(); /// CryptoJS 21 | getCryptoJS().MD5(str).toString(); /// md5 加密后的字符串 22 | ``` 23 | -------------------------------------------------------------------------------- /docs/functions/getDateTime.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getDateTime 6 | 7 | # Function: getDateTime() 8 | 9 | > **getDateTime**(`date`?): `number` 10 | 11 | 获取日期时间戳 12 | 13 | ## Parameters 14 | 15 | • **date?**: `string` \| `Date` 16 | 17 | 日期 18 | 19 | ## Returns 20 | 21 | `number` 22 | 23 | ## Example 24 | 25 | ```ts 26 | getDateTime(new Date()); /// time stamp 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/getDayInYear.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getDayInYear 6 | 7 | # Function: getDayInYear() 8 | 9 | > **getDayInYear**(`date`?): `number` 10 | 11 | 获取日期所在的年份中的天数 12 | 13 | ## Parameters 14 | 15 | • **date?**: `string` \| `Date` 16 | 17 | 日期 18 | 19 | ## Returns 20 | 21 | `number` 22 | 23 | ## Example 24 | 25 | ```ts 26 | getDayInYear('2023/06/23'); /// 174 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/getDecodeStorage.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getDecodeStorage 6 | 7 | # Function: getDecodeStorage() 8 | 9 | > **getDecodeStorage**(`key`, `isLocal`): `any` 10 | 11 | 获取 Storage 加密数据 12 | 13 | ## Parameters 14 | 15 | • **key**: `string` 16 | 17 | 存储 key 18 | 19 | • **isLocal**: `boolean` = `true` 20 | 21 | 是否 localStorage 22 | 23 | ## Returns 24 | 25 | `any` 26 | 27 | ## Example 28 | 29 | ```ts 30 | getDecodeStorage("key"); /// 处理过后的 value，不需要再 decode 和解密。 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/functions/getFileType.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getFileType 6 | 7 | # Function: getFileType() 8 | 9 | > **getFileType**(`str`): `string` 10 | 11 | 获取文件类型（扩展名）的小写格式。 12 | - 支持处理带有查询参数的路径。 13 | - 若无扩展名，返回 `unknown`。 14 | 15 | ## Parameters 16 | 17 | • **str**: `string` 18 | 19 | 字符串（URL 、路径或文件名）。 20 | 21 | ## Returns 22 | 23 | `string` 24 | 25 | ## Example 26 | 27 | ```ts 28 | getFileType('https://example.com/path/to/file.pdf'); // 'pdf' 29 | getFileType('file.JPG'); // 'jpg' 30 | getFileType('document'); // 'unknown' 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/functions/getFingerprint.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getFingerprint 6 | 7 | # Function: getFingerprint() 8 | 9 | > **getFingerprint**(`extraString`): `string` 10 | 11 | 获取简单的浏览器指纹 12 | 13 | ## Parameters 14 | 15 | • **extraString**: `string` \| `number` 16 | 17 | 额外的字符串，可以说用户名等。 18 | 19 | ## Returns 20 | 21 | `string` 22 | 23 | ## Example 24 | 25 | ```ts 26 | getFingerprint(); /// md5 加密后的指纹 27 | getFingerprint('test'); /// md5 加密后的指纹-建议增加使用者标识，避免指纹冲突。 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/getFirstVar.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getFirstVar 6 | 7 | # Function: getFirstVar() 8 | 9 | > **getFirstVar**(`data`): `any` 10 | 11 | 获取对象/数组第一个值 12 | 13 | ## Parameters 14 | 15 | • **data**: `any` 16 | 17 | 源数据 18 | 19 | ## Returns 20 | 21 | `any` 22 | 23 | ## Example 24 | 25 | ```ts 26 | getFirstVar([1, 2]); /// 1 27 | getFirstVar({a: 2,b: 1}); /// 2 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/getKey.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getKey 6 | 7 | # Function: getKey() 8 | 9 | > **getKey**(`size`, `prefix`?, `suffix`?): `string` 10 | 11 | 获取带前/后缀的唯一 key 12 | 13 | ## Parameters 14 | 15 | • **size**: `number` = `21` 16 | 17 | 指定长度 18 | 19 | • **prefix?**: `string` 20 | 21 | 前缀 22 | 23 | • **suffix?**: `string` 24 | 25 | ## Returns 26 | 27 | `string` 28 | 29 | ## Example 30 | 31 | ```ts 32 | getKey(); /// 'M2rmCcGpXCa5MTdN4Kks5' 33 | getKey(2, 'test'); /// 'test-aK' 34 | getKey(2, null, 'last'); /// 'aK-last' 35 | ``` 36 | -------------------------------------------------------------------------------- /docs/functions/getLastVar.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getLastVar 6 | 7 | # Function: getLastVar() 8 | 9 | > **getLastVar**(`data`): `any` 10 | 11 | 获取对象/数组最后一个值(对象为 Object.keys 的顺序) 12 | 13 | ## Parameters 14 | 15 | • **data**: `any` 16 | 17 | 源数据 18 | 19 | ## Returns 20 | 21 | `any` 22 | 23 | ## Example 24 | 25 | ```ts 26 | getLastVar([1, 2]); /// 2 27 | getLastVar({a: 2, b: 1}); /// b 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/getLocalArr.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getLocalArr 6 | 7 | # Function: getLocalArr() 8 | 9 | > **getLocalArr**(`key`): `any`[] 10 | 11 | 获取 localStorage 数组值 12 | 13 | ## Parameters 14 | 15 | • **key**: `string` 16 | 17 | 存储 key 18 | 19 | ## Returns 20 | 21 | `any`[] 22 | 23 | ## Example 24 | 25 | ```ts 26 | getLocalArr("key"); /// 处理过后的 value，不需要再 decode，且有默认值 []。 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/getLocalObj.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getLocalObj 6 | 7 | # Function: getLocalObj() 8 | 9 | > **getLocalObj**(`key`): `any` 10 | 11 | 获取 localStorage 对象值 12 | 13 | ## Parameters 14 | 15 | • **key**: `string` 16 | 17 | 存储 key 18 | 19 | ## Returns 20 | 21 | `any` 22 | 23 | ## Example 24 | 25 | ```ts 26 | getLocalObj("key"); /// 处理过后的 value，不需要再 decode，且有默认值 {}。 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/getMonthDayCount.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getMonthDayCount 6 | 7 | # Function: getMonthDayCount() 8 | 9 | > **getMonthDayCount**(`date`?): `number` 10 | 11 | 获取月份天数 12 | 13 | ## Parameters 14 | 15 | • **date?**: `string` \| `Date` 16 | 17 | 日期 18 | 19 | ## Returns 20 | 21 | `number` 22 | 23 | ## Example 24 | 25 | ```ts 26 | getMonthDayCount(new Date()); /// 30 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/getMonthInfo.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getMonthInfo 6 | 7 | # Function: getMonthInfo() 8 | 9 | > **getMonthInfo**(`n`): `object` \| `object`[] 10 | 11 | 获取月份信息 12 | 13 | ## Parameters 14 | 15 | • **n**: `string` \| `number` 16 | 17 | 值 18 | 19 | ## Returns 20 | 21 | `object` \| `object`[] 22 | 23 | ## Example 24 | 25 | ```ts 26 | getMonthInfo(); /// MONTH_INFO 27 | getMonthInfo('0'); /// MONTH_INFO 28 | getMonthInfo('ALL'); /// MONTH_INFO 29 | getMonthInfo('all'); /// MONTH_INFO 30 | getMonthInfo('unknown'); /// MONTH_INFO 31 | getMonthInfo(1); /// 一月相关信息 32 | getMonthInfo(13); /// MONTH_INFO 33 | ``` 34 | -------------------------------------------------------------------------------- /docs/functions/getPinYin.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getPinYin 6 | 7 | # Function: getPinYin() 8 | 9 | > **getPinYin**(`str`, `extractFirst`): `string` 10 | 11 | 获取汉字拼音或首字母 12 | 13 | ## Parameters 14 | 15 | • **str**: `string` 16 | 17 | 字符串值 18 | 19 | • **extractFirst**: `boolean` = `false` 20 | 21 | 是否只获取首字母 22 | 23 | ## Returns 24 | 25 | `string` 26 | 27 | ## Example 28 | 29 | ```ts 30 | getPinYin('你好'); /// 'NiHao' 31 | getPinYin('你好', true); /// 'NH' 32 | getPinYin('贺'); /// 'He' 33 | ``` 34 | -------------------------------------------------------------------------------- /docs/functions/getQueryString.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getQueryString 6 | 7 | # Function: getQueryString() 8 | 9 | > **getQueryString**(`url`?): `any` 10 | 11 | 获取 url 查询参数字符串 12 | 13 | ## Parameters 14 | 15 | • **url?**: `string` 16 | 17 | 地址/链接 18 | 19 | ## Returns 20 | 21 | `any` 22 | 23 | ## Example 24 | 25 | ```ts 26 | getQueryString('https://test.com/index?name=leo&org=biugle#test'); /// 'name=leo&org=biugle' 27 | getQueryString(''); /// '' 28 | getQueryString(); /// 当前页面 QueryString 字符串部分 29 | ``` 30 | -------------------------------------------------------------------------------- /docs/functions/getRandColor.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getRandColor 6 | 7 | # Function: getRandColor() 8 | 9 | > **getRandColor**(): `string` 10 | 11 | 获取随机颜色 12 | 13 | ## Returns 14 | 15 | `string` 16 | 17 | ## Example 18 | 19 | ```ts 20 | getRandColor(); /// '#xxxxxx' 21 | ``` 22 | -------------------------------------------------------------------------------- /docs/functions/getRandDate.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getRandDate 6 | 7 | # Function: getRandDate() 8 | 9 | > **getRandDate**(): `string` 10 | 11 | 获取随机日期时间 12 | 13 | ## Returns 14 | 15 | `string` 16 | 17 | ## Example 18 | 19 | ```ts 20 | getRandDate(); /// '1923-01-01 01:03:30' 21 | ``` 22 | -------------------------------------------------------------------------------- /docs/functions/getRandIp.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getRandIp 6 | 7 | # Function: getRandIp() 8 | 9 | > **getRandIp**(): `string` 10 | 11 | 获取随机 IP 地址 12 | 13 | ## Returns 14 | 15 | `string` 16 | 17 | ## Example 18 | 19 | ```ts 20 | getRandIp(); /// '89.0.142.86' 21 | ``` 22 | -------------------------------------------------------------------------------- /docs/functions/getRandNum.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getRandNum 6 | 7 | # Function: getRandNum() 8 | 9 | > **getRandNum**(`min`, `max`): `number` 10 | 11 | 获取随机数字 12 | 13 | ## Parameters 14 | 15 | • **min**: `number` = `0` 16 | 17 | 最小值 18 | 19 | • **max**: `number` = `10` 20 | 21 | 最大值 22 | 23 | ## Returns 24 | 25 | `number` 26 | 27 | ## Example 28 | 29 | ```ts 30 | getRandNum(1, 10); /// 1~10 之间的随机数，闭区间。 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/functions/getRandStr.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getRandStr 6 | 7 | # Function: getRandStr() 8 | 9 | > **getRandStr**(`length`): `string` 10 | 11 | 生成一个指定长度的随机数字符串 12 | 13 | ## Parameters 14 | 15 | • **length**: `number` 16 | 17 | 指定长度 18 | 19 | ## Returns 20 | 21 | `string` 22 | 23 | ## Example 24 | 25 | ```ts 26 | getRandStr(2); /// '43' 27 | getRandStr(5); /// '77192' 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/getRandVar.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getRandVar 6 | 7 | # Function: getRandVar() 8 | 9 | > **getRandVar**(`value`, `count`): `any` \| `any`[] 10 | 11 | 获取数组或对象随机数据 12 | 13 | ## Parameters 14 | 15 | • **value**: `any` 16 | 17 | 值 18 | 19 | • **count**: `number` = `1` 20 | 21 | 获取数据量 22 | 23 | ## Returns 24 | 25 | `any` \| `any`[] 26 | 27 | ## Example 28 | 29 | ```ts 30 | getRandVar({ a: 1, b: 3 }); /// 1 31 | getRandVar([1, 2, 3, 4], 2); /// [2, 4] 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/getScrollParent.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getScrollParent 6 | 7 | # Function: getScrollParent() 8 | 9 | > **getScrollParent**(`element`?): `HTMLElement` \| `Document` \| `any` 10 | 11 | 获取最近的可滚动父元素。 12 | 支持普通 DOM 、 Shadow DOM 和 iframe 。 13 | 14 | ## Parameters 15 | 16 | • **element?**: `any` 17 | 18 | 目标元素 19 | 20 | ## Returns 21 | 22 | `HTMLElement` \| `Document` \| `any` 23 | 24 | ## Example 25 | 26 | ```ts 27 | getScrollParent(document.querySelector('.form-error')); // Form 28 | getScrollParent(); /// document.documentElement 29 | ``` 30 | -------------------------------------------------------------------------------- /docs/functions/getScrollPercent.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getScrollPercent 6 | 7 | # Function: getScrollPercent() 8 | 9 | > **getScrollPercent**(`direction`, `dom`): `number` 10 | 11 | 获取滚动条百分比 12 | 13 | ## Parameters 14 | 15 | • **direction**: `"X"` \| `"Y"` = `'Y'` 16 | 17 | X/Y 轴的进度条 18 | 19 | • **dom**: `any` = `document.documentElement` 20 | 21 | 元素 22 | 23 | ## Returns 24 | 25 | `number` 26 | 27 | ## Example 28 | 29 | ```ts 30 | getScrollPercent(document.documentElement, 'Y'); /// 0.581134549876 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/functions/getSearchParams.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getSearchParams 6 | 7 | # Function: getSearchParams() 8 | 9 | > **getSearchParams**(`url`?): `any` 10 | 11 | 获取查询地址/链接中的参数对象 12 | 13 | ## Parameters 14 | 15 | • **url?**: `string` 16 | 17 | 地址/链接 18 | 19 | ## Returns 20 | 21 | `any` 22 | 23 | ## Example 24 | 25 | ```ts 26 | getSearchParams('https://test.com/index?name=leo&org=biugle#test'); /// {name: 'leo', org: 'biugle'} 27 | getSearchParams(''); /// {} 28 | getSearchParams(); /// 当前页面 SearchParams 对象 29 | ``` 30 | -------------------------------------------------------------------------------- /docs/functions/getSelectText.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getSelectText 6 | 7 | # Function: getSelectText() 8 | 9 | > **getSelectText**(): `undefined` \| `string` 10 | 11 | 获取鼠标选中内容 12 | 13 | ## Returns 14 | 15 | `undefined` \| `string` 16 | 17 | ## Example 18 | 19 | ```ts 20 | getSelectText() 21 | ``` 22 | -------------------------------------------------------------------------------- /docs/functions/getSessionArr.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getSessionArr 6 | 7 | # Function: getSessionArr() 8 | 9 | > **getSessionArr**(`key`): `any`[] 10 | 11 | 获取 sessionStorage 数组值 12 | 13 | ## Parameters 14 | 15 | • **key**: `string` 16 | 17 | 存储 key 18 | 19 | ## Returns 20 | 21 | `any`[] 22 | 23 | ## Example 24 | 25 | ```ts 26 | getSessionArr("key"); /// 处理过后的 value，不需要再 decode，且有默认值 []。 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/getSessionObj.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getSessionObj 6 | 7 | # Function: getSessionObj() 8 | 9 | > **getSessionObj**(`key`): `any` 10 | 11 | 获取 sessionStorage 对象值 12 | 13 | ## Parameters 14 | 15 | • **key**: `string` 16 | 17 | 存储 key 18 | 19 | ## Returns 20 | 21 | `any` 22 | 23 | ## Example 24 | 25 | ```ts 26 | getSessionObj("key"); /// 处理过后的 value，不需要再 decode，且有默认值 {}。 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/getSortVar.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getSortVar 6 | 7 | # Function: getSortVar() 8 | 9 | > **getSortVar**(`value`): `any` 10 | 11 | 获取排序转换后的数组或对象（仅支持单层简单结构） 12 | 13 | ## Parameters 14 | 15 | • **value**: `any` 16 | 17 | 值 18 | 19 | ## Returns 20 | 21 | `any` 22 | 23 | ## Example 24 | 25 | ```ts 26 | getSortVar({ b: 3, a: 2 }); /// { a: 2, b: 3 } 27 | getSortVar({ a: 2, b: 3 }); /// { a: 2, b: 3 } 28 | getSortVar([1, 3, 2]); /// [1, 2, 3] 29 | ``` 30 | -------------------------------------------------------------------------------- /docs/functions/getStyleByName.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getStyleByName 6 | 7 | # Function: getStyleByName() 8 | 9 | > **getStyleByName**(`element`, `name`): `any` 10 | 11 | 获取任一元素的 style 任意属性 12 | 13 | ## Parameters 14 | 15 | • **element**: `any` 16 | 17 | 指定元素 18 | 19 | • **name**: `any` 20 | 21 | 属性名称 22 | 23 | ## Returns 24 | 25 | `any` 26 | 27 | ## Example 28 | 29 | ```ts 30 | getStyle(document.getElementById('test'), 'width'); /// #test 的 width 属性 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/functions/getTimeCode.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getTimeCode 6 | 7 | # Function: getTimeCode() 8 | 9 | > **getTimeCode**(): `string` 10 | 11 | 获取 16 位可读时间戳 12 | 13 | ## Returns 14 | 15 | `string` 16 | 17 | ## Example 18 | 19 | ```ts 20 | getTimeCode(); /// '2036551026042022' 21 | ``` 22 | -------------------------------------------------------------------------------- /docs/functions/getTimezone.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getTimezone 6 | 7 | # Function: getTimezone() 8 | 9 | > **getTimezone**(): `string` 10 | 11 | 获取当前时区的标准格式表示。 12 | 13 | ## Returns 14 | 15 | `string` 16 | 17 | ## Example 18 | 19 | ```ts 20 | // 如果时区为 UTC+8 21 | getTimezone(); // '+8' 22 | // 如果时区为 UTC-5 23 | getTimezone(); // '-5' 24 | // 如果时区为 UTC 25 | getTimezone(); // '+0' 26 | ``` 27 | -------------------------------------------------------------------------------- /docs/functions/getTreeData.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getTreeData 6 | 7 | # Function: getTreeData() 8 | 9 | > **getTreeData**(`treeData`, `key`): `object` 10 | 11 | 获取转换后树的映射对象、数组 `{ map: any, list: any[] }` 12 | 13 | ## Parameters 14 | 15 | • **treeData**: `any`[] 16 | 17 | 树值 18 | 19 | • **key**: `string` = `'key'` 20 | 21 | key 22 | 23 | ## Returns 24 | 25 | `object` 26 | 27 | ### list 28 | 29 | > **list**: `any`[] 30 | 31 | ### map 32 | 33 | > **map**: `any` 34 | 35 | ## Example 36 | 37 | ```ts 38 | getTreeData(treeData, 'id'); /// { map: any, list: any[] } 39 | getTreeData(treeData, 'data.id'); /// { map: any, list: any[] } 40 | ``` 41 | -------------------------------------------------------------------------------- /docs/functions/getType.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getType 6 | 7 | # Function: getType() 8 | 9 | > **getType**(`variable`): `string` 10 | 11 | 获取变量类型 12 | 13 | ## Parameters 14 | 15 | • **variable**: `any` 16 | 17 | 变量 18 | 19 | ## Returns 20 | 21 | `string` 22 | 23 | ## Example 24 | 25 | ```ts 26 | getType(1); /// 'number' 27 | getType(async function(){}); /// 'asyncfunction' 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/getUTCTime.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getUTCTime 6 | 7 | # Function: getUTCTime() 8 | 9 | > **getUTCTime**(`timezone`): `Date` 10 | 11 | 获取标准时间 UTC 12 | 适用于本地时间不准确或者获取其他时区时间的情况 13 | 14 | ## Parameters 15 | 16 | • **timezone**: `number` = `0` 17 | 18 | 时区数字，东八区为 8，西八区为 -8 。 19 | 20 | ## Returns 21 | 22 | `Date` 23 | 24 | ## Example 25 | 26 | ```ts 27 | getUTCTime(8); /// 中国标准时间-东八区 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/getUserAgent.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getUserAgent 6 | 7 | # Function: getUserAgent() 8 | 9 | > **getUserAgent**(): `object` 10 | 11 | 获取浏览器信息 12 | 13 | ## Returns 14 | 15 | `object` 16 | 17 | ### browserName 18 | 19 | > **browserName**: `string` 20 | 21 | ### browserVersion 22 | 23 | > **browserVersion**: `string` 24 | 25 | ### osName 26 | 27 | > **osName**: `string` 28 | 29 | ### osVersion 30 | 31 | > **osVersion**: `string` 32 | 33 | ## Example 34 | 35 | ```ts 36 | getUserAgent(); /// { browserName: 'Chrome', browserVersion: '102.0.0.0', osName: 'Windows', osVersion: '10.0', deviceName: '' } 37 | ``` 38 | -------------------------------------------------------------------------------- /docs/functions/getVarSize.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getVarSize 6 | 7 | # Function: getVarSize() 8 | 9 | > **getVarSize**(`value`): `number` 10 | 11 | 获取任意变量长度 12 | 13 | ## Parameters 14 | 15 | • **value**: `any` 16 | 17 | 值 18 | 19 | ## Returns 20 | 21 | `number` 22 | 23 | ## Example 24 | 25 | ```ts 26 | getVarSize([]); /// 0 27 | getVarSize({a: 1, b: 2}); /// 2 28 | getVarSize(null); /// 0 29 | ``` 30 | -------------------------------------------------------------------------------- /docs/functions/getViewportSize.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getViewportSize 6 | 7 | # Function: getViewportSize() 8 | 9 | > **getViewportSize**(): `object` 10 | 11 | 获取窗口尺寸 12 | 13 | ## Returns 14 | 15 | `object` 16 | 17 | ### h 18 | 19 | > **h**: `number` = `window.innerHeight` 20 | 21 | ### w 22 | 23 | > **w**: `number` = `window.innerWidth` 24 | 25 | ## Example 26 | 27 | ```ts 28 | getViewportSize(); /// { width: 1280, height: 649 } 29 | ``` 30 | -------------------------------------------------------------------------------- /docs/functions/getWebSocket.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getWebSocket 6 | 7 | # Function: getWebSocket() 8 | 9 | > **getWebSocket**(): `WebSocket` \| `undefined` 10 | 11 | 获取 websocket 实例 12 | 13 | ## Returns 14 | 15 | `WebSocket` \| `undefined` 16 | 17 | ## Example 18 | 19 | ```ts 20 | getWebSocket(); /// [websocket object] 21 | ``` 22 | -------------------------------------------------------------------------------- /docs/functions/getWeekInfo.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / getWeekInfo 6 | 7 | # Function: getWeekInfo() 8 | 9 | > **getWeekInfo**(`n`): `object` \| `object`[] 10 | 11 | 获取星期信息 12 | 13 | ## Parameters 14 | 15 | • **n**: `string` \| `number` 16 | 17 | 值 18 | 19 | ## Returns 20 | 21 | `object` \| `object`[] 22 | 23 | ## Example 24 | 25 | ```ts 26 | getWeekInfo(); /// WEEKS_INFO 27 | getWeekInfo('0'); /// WEEKS_INFO 28 | getWeekInfo('ALL'); /// WEEKS_INFO 29 | getWeekInfo('all'); /// WEEKS_INFO 30 | getWeekInfo('unknown'); /// WEEKS_INFO 31 | getWeekInfo(1); /// 星期一相关信息 32 | getWeekInfo(8); /// WEEKS_INFO 33 | ``` 34 | -------------------------------------------------------------------------------- /docs/functions/globalError.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / globalError 6 | 7 | # Function: globalError() 8 | 9 | > **globalError**(`fn`, `notShowConsole`): `void` 10 | 11 | 全局尽可能捕获异常 12 | 13 | ## Parameters 14 | 15 | • **fn**: `any` 16 | 17 | (error) 18 | 19 | • **notShowConsole**: `boolean` = `true` 20 | 21 | 是否不回显控制台 22 | 23 | ## Returns 24 | 25 | `void` 26 | 27 | ## Example 28 | 29 | ```ts 30 | globalError((error) => console.log('全局捕获异常'), false); /// '全局捕获异常' 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/functions/hasKey.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / hasKey 6 | 7 | # Function: hasKey() 8 | 9 | > **hasKey**(`data`, `key`): `boolean` 10 | 11 | 对象/数组包含某个 key/index 或者属性 12 | 13 | ## Parameters 14 | 15 | • **data**: `any` 16 | 17 | 对象 18 | 19 | • **key**: `string` 20 | 21 | 需要判断的 key 22 | 23 | ## Returns 24 | 25 | `boolean` 26 | 27 | ## Example 28 | 29 | ```ts 30 | hasKey({ a: 1 }, 'a'); /// true 31 | hasKey([0, 1], '0'); /// true 32 | hasKey([0, 1], 2); /// false 33 | hasKey({ a: 1 }, 'b'); /// false 34 | const a = { a: 1 }; 35 | a.__proto__.x = 1; 36 | hasKey(a, 'x'); /// true; 37 | ``` 38 | -------------------------------------------------------------------------------- /docs/functions/hasSpecialChar.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / hasSpecialChar 6 | 7 | # Function: hasSpecialChar() 8 | 9 | > **hasSpecialChar**(`value`): `boolean` 10 | 11 | 是否全为英文 12 | 13 | ## Parameters 14 | 15 | • **value**: `string` 16 | 17 | 字符串值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | hasSpecialChar('Aa('); /// true 27 | hasSpecialChar('a1'); /// false 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/hideToast.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / hideToast 6 | 7 | # Function: hideToast() 8 | 9 | > **hideToast**(`toast`?): `void` 10 | 11 | 隐藏 toast 不传值关闭所有 toast 12 | 13 | ## Parameters 14 | 15 | • **toast?**: `any` 16 | 17 | toast 实例 18 | 19 | ## Returns 20 | 21 | `void` 22 | 23 | ## Example 24 | 25 | ```ts 26 | const $toast = showToast({ content: '这是一个演示 Toast' }); /// hideToast($toast); 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/html2str.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / html2str 6 | 7 | # Function: html2str() 8 | 9 | > **html2str**(`value`): `string` \| `null` 10 | 11 | 实体字符转字符串 12 | 13 | ## Parameters 14 | 15 | • **value**: `string` 16 | 17 | 实体字符串 18 | 19 | ## Returns 20 | 21 | `string` \| `null` 22 | 23 | ## Example 24 | 25 | ```ts 26 | html2str('<>&"'); /// '<>&"' 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/inRange.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / inRange 6 | 7 | # Function: inRange() 8 | 9 | > **inRange**(`value`, `min`, `max`): `boolean` 10 | 11 | 判断一个数是否在指定范围（闭区间） 12 | 13 | ## Parameters 14 | 15 | • **value**: `any` 16 | 17 | 数值 18 | 19 | • **min**: `number` 20 | 21 | 最小值 22 | 23 | • **max**: `number` 24 | 25 | 最大值 26 | 27 | ## Returns 28 | 29 | `boolean` 30 | 31 | ## Example 32 | 33 | ```ts 34 | inRange(null, 0, 3); /// false 35 | inRange(0, 0, 3); /// true 36 | inRange(3, 0, 3); /// true 37 | inRange(5, 0, 3); /// false 38 | ``` 39 | -------------------------------------------------------------------------------- /docs/functions/initNotification.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / initNotification 6 | 7 | # Function: initNotification() 8 | 9 | > **initNotification**(): `boolean` 10 | 11 | 初始化 Notification 12 | 13 | ## Returns 14 | 15 | `boolean` 16 | 17 | ## Example 18 | 19 | ```ts 20 | initNotification(); /// true||false 21 | ``` 22 | -------------------------------------------------------------------------------- /docs/functions/insertAfter.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / insertAfter 6 | 7 | # Function: insertAfter() 8 | 9 | > **insertAfter**(`newElement`, `targetElement`): `void` 10 | 11 | 插入某元素到指定 Element 之后 12 | 13 | ## Parameters 14 | 15 | • **newElement**: `any` 16 | 17 | 某元素 18 | 19 | • **targetElement**: `any` 20 | 21 | 指定元素 22 | 23 | ## Returns 24 | 25 | `void` 26 | 27 | ## Example 28 | 29 | ```ts 30 | insertAfter(document.getElementById('a'), document.getElementById('b')); 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/functions/intersection.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / intersection 6 | 7 | # Function: intersection() 8 | 9 | > **intersection**(`paramA`, `paramB`): `any` 10 | 11 | 获取数组或对象交集 12 | 13 | ## Parameters 14 | 15 | • **paramA**: `any` 16 | 17 | 值 A 18 | 19 | • **paramB**: `any` 20 | 21 | 值 B 22 | 23 | ## Returns 24 | 25 | `any` 26 | 27 | ## Example 28 | 29 | ```ts 30 | intersection([1, 2, 2, 3, 3], [1, 2, 4, 5]); /// [1, 2] 31 | intersection({a: 1, b: 2}, {a: 1, c: 3, b: 4}); /// {a: 1} 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/inversion.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / inversion 6 | 7 | # Function: inversion() 8 | 9 | > **inversion**(`value`): `any` 10 | 11 | 反转数组或者字符串 12 | 13 | ## Parameters 14 | 15 | • **value**: `any` 16 | 17 | 值 18 | 19 | ## Returns 20 | 21 | `any` 22 | 23 | ## Example 24 | 25 | ```ts 26 | inversion([1, 2, 3]); /// [3, 2, 1] 27 | inversion('123'); /// '321' 28 | inversion(); /// undefined 29 | inversion(true); /// true 30 | ``` 31 | -------------------------------------------------------------------------------- /docs/functions/isAccount.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isAccount 6 | 7 | # Function: isAccount() 8 | 9 | > **isAccount**(`value`, `hasChinese`): `boolean` 10 | 11 | 检查是否为 char string 用户名规范(字母数字下划线或中文) 12 | 13 | ## Parameters 14 | 15 | • **value**: `string` 16 | 17 | 字符串值 18 | 19 | • **hasChinese**: `boolean` = `false` 20 | 21 | ## Returns 22 | 23 | `boolean` 24 | 25 | ## Example 26 | 27 | ```ts 28 | isAccount('test123@qq.com'); /// false 29 | isAccount('_test123_qq_com'); /// false 30 | isAccount('test123_qq_com'); /// true 31 | isAccount('我test123_qq_com'); /// false 32 | isAccount('我test123_qq_com', true); /// true 33 | ``` 34 | -------------------------------------------------------------------------------- /docs/functions/isAppleDevice.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isAppleDevice 6 | 7 | # Function: isAppleDevice() 8 | 9 | > **isAppleDevice**(): `boolean` 10 | 11 | 是否苹果设备 12 | 13 | ## Returns 14 | 15 | `boolean` 16 | 17 | ## Example 18 | 19 | ```ts 20 | isAppleDevice(); /// true 21 | ``` 22 | -------------------------------------------------------------------------------- /docs/functions/isArr.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isArr 6 | 7 | # Function: isArr() 8 | 9 | > **isArr**(`value`): `boolean` 10 | 11 | 检查是否数组 12 | 13 | ## Parameters 14 | 15 | • **value**: `any` 16 | 17 | 值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isArr([]); /// true 27 | isArr({}); /// false 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/isArrayBuffer.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isArrayBuffer 6 | 7 | # Function: isArrayBuffer() 8 | 9 | > **isArrayBuffer**(`value`): `boolean` 10 | 11 | 检查是否为 ArrayBuffer 12 | 13 | ## Parameters 14 | 15 | • **value**: `any` 16 | 17 | 值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isArrayBuffer(new ArrayBuffer()); /// true 27 | isArrayBuffer(null); /// false 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/isBankCard.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isBankCard 6 | 7 | # Function: isBankCard() 8 | 9 | > **isBankCard**(`value`): `boolean` 10 | 11 | 判断是否为银行卡号 12 | 13 | ## Parameters 14 | 15 | • **value**: `string` 16 | 17 | 字符串值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isBankCard('6217003810026896707'); /// true 27 | isBankCard('12312312312'); /// false 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/isBlob.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isBlob 6 | 7 | # Function: isBlob() 8 | 9 | > **isBlob**(`value`): `boolean` 10 | 11 | 检查是否为 Blob 12 | 13 | ## Parameters 14 | 15 | • **value**: `any` 16 | 17 | 值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isBlob(new Blob()); /// true 27 | isBlob(null); /// false 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/isBool.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isBool 6 | 7 | # Function: isBool() 8 | 9 | > **isBool**(`value`): `boolean` 10 | 11 | 检查是否为 boolean 类型 12 | 13 | ## Parameters 14 | 15 | • **value**: `any` 16 | 17 | 值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isBool(true); /// true 27 | isBool(null); /// false 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/isBrowser.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isBrowser 6 | 7 | # Function: isBrowser() 8 | 9 | > **isBrowser**(): `boolean` 10 | 11 | 判断当前运行环境是否为浏览器 12 | 13 | ## Returns 14 | 15 | `boolean` 16 | 17 | ## Example 18 | 19 | ```ts 20 | isBrowser(); /// true 21 | ``` 22 | -------------------------------------------------------------------------------- /docs/functions/isCSR.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isCSR 6 | 7 | # Function: isCSR() 8 | 9 | > **isCSR**(): `boolean` 10 | 11 | 判断是否客户端渲染 12 | 13 | ## Returns 14 | 15 | `boolean` 16 | 17 | ## Example 18 | 19 | ```ts 20 | isCSR(); /// true 21 | ``` 22 | -------------------------------------------------------------------------------- /docs/functions/isCarCode.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isCarCode 6 | 7 | # Function: isCarCode() 8 | 9 | > **isCarCode**(`value`): `boolean` 10 | 11 | 检查是否为 carCode string 车牌号 12 | 13 | ## Parameters 14 | 15 | • **value**: `string` 16 | 17 | 字符串值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isCarCode('粤B68928'); /// true 27 | isCarCode('粤-B68928'); /// true 28 | isCarCode('粤 B68928'); /// true 29 | isCarCode('粤B.68928'); /// true 30 | isCarCode('粤B 68928'); /// true 31 | isCarCode('广东 B12345'); /// false 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/isChinese.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isChinese 6 | 7 | # Function: isChinese() 8 | 9 | > **isChinese**(`value`): `boolean` 10 | 11 | 是否全为中文 12 | 13 | ## Parameters 14 | 15 | • **value**: `string` 16 | 17 | 字符串值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isChinese('呜呜呜'); /// true 27 | isChinese('我 1'); /// false 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/isChrome.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isChrome 6 | 7 | # Function: isChrome() 8 | 9 | > **isChrome**(): `boolean` 10 | 11 | 判断是否 Chrome 内核 12 | 13 | ## Returns 14 | 15 | `boolean` 16 | 17 | ## Example 18 | 19 | ```ts 20 | isChrome(); /// true 21 | ``` 22 | -------------------------------------------------------------------------------- /docs/functions/isCreditCode.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isCreditCode 6 | 7 | # Function: isCreditCode() 8 | 9 | > **isCreditCode**(`value`): `boolean` 10 | 11 | 判断是否为统一社会信用代码 12 | 13 | ## Parameters 14 | 15 | • **value**: `string` 16 | 17 | 字符串值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isCreditCode('9144030071526726XG'); /// true 27 | isCreditCode('12312312312'); /// false 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/isDarkMode.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isDarkMode 6 | 7 | # Function: isDarkMode() 8 | 9 | > **isDarkMode**(): `boolean` 10 | 11 | 检测黑暗模式 12 | 13 | ## Returns 14 | 15 | `boolean` 16 | 17 | ## Example 18 | 19 | ```ts 20 | isDarkMode(); /// true 21 | ``` 22 | -------------------------------------------------------------------------------- /docs/functions/isDate.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isDate 6 | 7 | # Function: isDate() 8 | 9 | > **isDate**(`value`): `boolean` 10 | 11 | 检查是否 date 类型 12 | 13 | ## Parameters 14 | 15 | • **value**: `any` 16 | 17 | 值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isDate(new Date()); /// true 27 | isDate(null); /// false 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/isDecimal.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isDecimal 6 | 7 | # Function: isDecimal() 8 | 9 | > **isDecimal**(`value`, `type`?, `noLastZero`?): `boolean` 10 | 11 | 是否小数(严格匹配) 12 | 13 | ## Parameters 14 | 15 | • **value**: `string` 16 | 17 | • **type?**: `"-"` \| `"+"` 18 | 19 | • **noLastZero?**: `boolean` = `false` 20 | 21 | ## Returns 22 | 23 | `boolean` 24 | 25 | ## Example 26 | 27 | ```ts 28 | isDecimal('0.0'); /// true 29 | isDecimal('0.0', '+', true); /// false 30 | isDecimal('-0.1', '+'); /// false 31 | isDecimal('-0.10', '-'); /// true 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/isElement.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isElement 6 | 7 | # Function: isElement() 8 | 9 | > **isElement**(`value`): `boolean` 10 | 11 | 检查是否为 dom 元素 12 | 13 | ## Parameters 14 | 15 | • **value**: `any` 16 | 17 | 值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isElement(document.body); /// true 27 | isElement(document); /// false 28 | isElement({}); /// false 29 | ``` 30 | -------------------------------------------------------------------------------- /docs/functions/isEmail.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isEmail 6 | 7 | # Function: isEmail() 8 | 9 | > **isEmail**(`value`): `boolean` 10 | 11 | 检查是否为 email string 邮箱 12 | 13 | ## Parameters 14 | 15 | • **value**: `string` 16 | 17 | 字符串值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isEmail('test@qq.com'); /// true 27 | isEmail('@qq.com'); /// false 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/isEnglish.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isEnglish 6 | 7 | # Function: isEnglish() 8 | 9 | > **isEnglish**(`value`): `boolean` 10 | 11 | 是否全为英文 12 | 13 | ## Parameters 14 | 15 | • **value**: `string` 16 | 17 | 字符串值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isEnglish('Aa'); /// true 27 | isEnglish('a1'); /// false 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/isEqual.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isEqual 6 | 7 | # Function: isEqual() 8 | 9 | > **isEqual**(`obj1`, `obj2`): `boolean` 10 | 11 | 判断两个值是否相等 12 | 13 | ## Parameters 14 | 15 | • **obj1**: `any` 16 | 17 | 值 1 18 | 19 | • **obj2**: `any` 20 | 21 | 值 2 22 | 23 | ## Returns 24 | 25 | `boolean` 26 | 27 | ## Example 28 | 29 | ```ts 30 | isEqual([1, 2, 3], [1, 2, 3]); /// true 31 | isEqual({a: 1, b: 2}, {a: 1, b: 2}); /// true 32 | isEqual({}, {}); /// true 33 | isEqual(1, 1); /// true 34 | isEqual(1, '1'); /// false 35 | ``` 36 | -------------------------------------------------------------------------------- /docs/functions/isEven.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isEven 6 | 7 | # Function: isEven() 8 | 9 | > **isEven**(`value`): `boolean` 10 | 11 | 检查一个数字是否偶数 12 | 13 | ## Parameters 14 | 15 | • **value**: `number` 16 | 17 | 数值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isEven(-2); /// true 27 | isEven(1); /// false 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/isFn.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isFn 6 | 7 | # Function: isFn() 8 | 9 | > **isFn**(`value`): `boolean` 10 | 11 | 检查是否为 function 12 | 13 | ## Parameters 14 | 15 | • **value**: `any` 16 | 17 | 值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isFn(function(){}); /// true 27 | isFn(async function(){}); /// true 28 | isFn(new Promise((resolve, reject) => resolve()); /// false 29 | isFn({}); /// false 30 | ``` 31 | -------------------------------------------------------------------------------- /docs/functions/isHttp.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isHttp 6 | 7 | # Function: isHttp() 8 | 9 | > **isHttp**(`value`): `-1` \| `1` \| `0` 10 | 11 | 检查是否为 http 协议，1 是，-1 为 https，0 啥也不是。 12 | 13 | ## Parameters 14 | 15 | • **value**: `string` 16 | 17 | 字符串值 18 | 19 | ## Returns 20 | 21 | `-1` \| `1` \| `0` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isHttp('http://test.com'); /// 1 27 | isHttp('http:test.com'); /// 0 28 | isHttp('https://test.com'); /// -1 29 | isHttp('12345'); /// 0 30 | ``` 31 | -------------------------------------------------------------------------------- /docs/functions/isInteger.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isInteger 6 | 7 | # Function: isInteger() 8 | 9 | > **isInteger**(`value`, `type`?): `boolean` 10 | 11 | 是否整数(严格匹配) 12 | 13 | ## Parameters 14 | 15 | • **value**: `string` 16 | 17 | • **type?**: `"-"` \| `"+"` 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isInteger('0'); /// true 27 | isInteger('-0', '+'); /// false 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/isInvalidDate.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isInvalidDate 6 | 7 | # Function: isInvalidDate() 8 | 9 | > **isInvalidDate**(`date`): `boolean` 10 | 11 | 检查是否 Invalid Date 类型 12 | 13 | ## Parameters 14 | 15 | • **date**: `any` 16 | 17 | 值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isInvalidDate(new Date()); /// false 27 | isInvalidDate(null); /// false 28 | isInvalidDate(undefined); /// true 29 | isInvalidDate(new Date('invalid date')); /// true 30 | ``` 31 | -------------------------------------------------------------------------------- /docs/functions/isIpAddress.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isIpAddress 6 | 7 | # Function: isIpAddress() 8 | 9 | > **isIpAddress**(`value`): `boolean` 10 | 11 | 检查是否为 ip string 12 | 13 | ## Parameters 14 | 15 | • **value**: `string` 16 | 17 | 字符串值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isIpAddress('::1'); /// true 27 | isIpAddress('127.0.0.1'); /// true 28 | isIpAddress('2001:DB8:0:0:8:800:200C:417A'); /// true 29 | isIpAddress('255.255.255.123.123'); /// false 30 | ``` 31 | -------------------------------------------------------------------------------- /docs/functions/isIpv4.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isIpv4 6 | 7 | # Function: isIpv4() 8 | 9 | > **isIpv4**(`value`): `boolean` 10 | 11 | 检查是否为 ipv4 string 12 | 13 | ## Parameters 14 | 15 | • **value**: `string` 16 | 17 | 字符串值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isIpv4('127.0.0.1'); /// true 27 | isIpv4('255.255.255.0'); /// true 28 | isIpv4('255.255.255.2555'); /// false 29 | isIpv4('255.255.255.2555.255'); /// false 30 | ``` 31 | -------------------------------------------------------------------------------- /docs/functions/isIpv6.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isIpv6 6 | 7 | # Function: isIpv6() 8 | 9 | > **isIpv6**(`value`): `boolean` 10 | 11 | 检查是否为 ipv6 string 12 | 13 | ## Parameters 14 | 15 | • **value**: `string` 16 | 17 | 字符串值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isIpv6('::1'); /// true 27 | isIpv6('127.0.0.1'); /// false 28 | isIpv6('2000:0000:0000:0000:0001:2345:6789:abcd'); /// true 29 | isIpv6('2001:DB8:0:0:8:800:200C:417A'); /// true 30 | isIpv6('2001:DB8::8:800:200C:417A'); /// false 暂不兼容缩写 31 | isIpv6('2001:DB8:0:0:8:800:200C:417A:123'); /// false 32 | isIpv6('2000:0000:0000:0000:0001:2345:6789:abcd:1'); /// false 33 | ``` 34 | -------------------------------------------------------------------------------- /docs/functions/isJSON.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isJSON 6 | 7 | # Function: isJSON() 8 | 9 | > **isJSON**(`str`): `boolean` 10 | 11 | 检查字符串是否为有效的 JSON 12 | 13 | ## Parameters 14 | 15 | • **str**: `any` 16 | 17 | 字符串 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isJSON('{"name":"leo", "age":20}'); /// true 27 | isJSON('{"name":"leo", age:"20"}'); /// false 28 | isJSON(null); /// true 29 | ``` 30 | -------------------------------------------------------------------------------- /docs/functions/isLatitude.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isLatitude 6 | 7 | # Function: isLatitude() 8 | 9 | > **isLatitude**(`value`): `boolean` 10 | 11 | 检查是否为纬度 12 | 13 | ## Parameters 14 | 15 | • **value**: `string` 16 | 17 | 值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isLatitude(-90.1); /// false 27 | isLatitude(90); /// true 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/isLocalHost.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isLocalHost 6 | 7 | # Function: isLocalHost() 8 | 9 | > **isLocalHost**(`str`?): `boolean` 10 | 11 | 检查是否为本地启动 12 | 13 | ## Parameters 14 | 15 | • **str?**: `string` 16 | 17 | 字符串值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isLocalHost(); /// true 27 | isLocalHost('https://a.biugle.cn/xxx'); /// false 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/isLongitude.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isLongitude 6 | 7 | # Function: isLongitude() 8 | 9 | > **isLongitude**(`value`): `boolean` 10 | 11 | 检查是否为经度 12 | 13 | ## Parameters 14 | 15 | • **value**: `string` 16 | 17 | 值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isLongitude(-181); /// false 27 | isLongitude(179.12); /// true 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/isMac.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isMac 6 | 7 | # Function: isMac() 8 | 9 | > **isMac**(): `boolean` 10 | 11 | 判断是否 MacOS 12 | 13 | ## Returns 14 | 15 | `boolean` 16 | 17 | ## Example 18 | 19 | ```ts 20 | isMac(); /// true 21 | ``` 22 | -------------------------------------------------------------------------------- /docs/functions/isMobile.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isMobile 6 | 7 | # Function: isMobile() 8 | 9 | > **isMobile**(`value`): `boolean` 10 | 11 | 检查是否为 string 手机号 12 | 13 | ## Parameters 14 | 15 | • **value**: `string` 16 | 17 | 字符串值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isMobile('13579246810'); /// true 27 | isMobile('12345678910'); /// false 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/isNaN.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isNaN 6 | 7 | # Function: isNaN() 8 | 9 | > **isNaN**(`value`): `boolean` 10 | 11 | 检查是否为 NaN 12 | 13 | ## Parameters 14 | 15 | • **value**: `any` 16 | 17 | 值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isNaN(1); /// false 27 | isNaN(NaN); /// true 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/isNode.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isNode 6 | 7 | # Function: isNode() 8 | 9 | > **isNode**(): `boolean` 10 | 11 | 判断当前运行环境是否为 Node.js 12 | 13 | ## Returns 14 | 15 | `boolean` 16 | 17 | ## Example 18 | 19 | ```ts 20 | isNode(); /// true 21 | ``` 22 | -------------------------------------------------------------------------------- /docs/functions/isNull.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isNull 6 | 7 | # Function: isNull() 8 | 9 | > **isNull**(`value`): `boolean` 10 | 11 | 检查是否 null 12 | 13 | ## Parameters 14 | 15 | • **value**: `any` 16 | 17 | 值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isNull(undefined); /// false 27 | isNull(null); /// true 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/isNum.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isNum 6 | 7 | # Function: isNum() 8 | 9 | > **isNum**(`value`): `boolean` 10 | 11 | 检查是否 number 类型 12 | 13 | ## Parameters 14 | 15 | • **value**: `any` 16 | 17 | 值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isNum(NaN); /// false 27 | isNum(1); /// true 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/isObj.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isObj 6 | 7 | # Function: isObj() 8 | 9 | > **isObj**(`value`): `boolean` 10 | 11 | 检查是否对象 12 | 13 | ## Parameters 14 | 15 | • **value**: `any` 16 | 17 | 值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isObj({}); /// true 27 | isObj(null); /// false 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/isPromise.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isPromise 6 | 7 | # Function: isPromise() 8 | 9 | > **isPromise**(`value`): `boolean` 10 | 11 | 检查是否为 Promise 12 | 13 | ## Parameters 14 | 15 | • **value**: `any` 16 | 17 | 值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isPromise(function(){}); /// false 27 | isPromise(async function(){}); /// false 28 | isPromise(new Promise((resolve, reject) => resolve())); /// true 29 | ``` 30 | -------------------------------------------------------------------------------- /docs/functions/isQQ.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isQQ 6 | 7 | # Function: isQQ() 8 | 9 | > **isQQ**(`value`): `boolean` 10 | 11 | 检查是否为 QQ 号 12 | 13 | ## Parameters 14 | 15 | • **value**: `string` 16 | 17 | 字符串值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isQQ('1005760694'); /// true 27 | isQQ('123456789101'); /// false 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/isRhNegative.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isRhNegative 6 | 7 | # Function: isRhNegative() 8 | 9 | > **isRhNegative**(`input`): `boolean` 10 | 11 | 是否阴性血 12 | 13 | ## Parameters 14 | 15 | • **input**: `string` 16 | 17 | 输入值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isRhNegative('**d**'); /// true 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/isStr.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isStr 6 | 7 | # Function: isStr() 8 | 9 | > **isStr**(`value`): `boolean` 10 | 11 | 检查是否字符串类型 12 | 13 | ## Parameters 14 | 15 | • **value**: `any` 16 | 17 | 值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isStr('test'); /// true 27 | isStr(null); /// false 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/isStrongPassWord.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isStrongPassWord 6 | 7 | # Function: isStrongPassWord() 8 | 9 | > **isStrongPassWord**(`value`): `boolean` 10 | 11 | 检查密码强度是否足够 12 | 13 | ## Parameters 14 | 15 | • **value**: `string` 16 | 17 | 字符串值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isStrongPassWord('test@qq.com'); /// false 27 | isStrongPassWord('test@qq.com123'); /// true 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/isTel.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isTel 6 | 7 | # Function: isTel() 8 | 9 | > **isTel**(`value`): `boolean` 10 | 11 | 判断数据是否为座机号(固定电话) 12 | 13 | ## Parameters 14 | 15 | • **value**: `string` 16 | 17 | 字符串值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isTel('0731-24722145'); /// true 27 | isTel('13579246810'); /// false 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/isUndef.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isUndef 6 | 7 | # Function: isUndef() 8 | 9 | > **isUndef**(`value`): `boolean` 10 | 11 | 检查是否 undefined 12 | 该函数使用 `void 0` 来判断是否为 `undefined`，而不是直接与全局的 `undefined` 变量比较。 13 | 使用 `void 0` 的好处是，即使全局的 `undefined` 变量被重新赋值，`void 0` 依然保证返回真正的 undefined 。 14 | 15 | ## Parameters 16 | 17 | • **value**: `any` 18 | 19 | 值 20 | 21 | ## Returns 22 | 23 | `boolean` 24 | 25 | ## Example 26 | 27 | ```ts 28 | isUndef(undefined); /// true 29 | isUndef(null); /// false 30 | isUndef(void 0); /// true 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/functions/isUrl.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isUrl 6 | 7 | # Function: isUrl() 8 | 9 | > **isUrl**(`value`): `boolean` 10 | 11 | 检查是否为 url string 12 | 13 | ## Parameters 14 | 15 | • **value**: `string` 16 | 17 | 字符串值 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isUrl('http://www.example.com?foo=bar¶m=test'); /// true 27 | isUrl(http://www); /// false 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/isWeekday.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isWeekday 6 | 7 | # Function: isWeekday() 8 | 9 | > **isWeekday**(`date`?): `boolean` 10 | 11 | 检查所提供的日期是否为工作日 12 | 13 | ## Parameters 14 | 15 | • **date?**: `string` \| `Date` 16 | 17 | 日期 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | isWorkDay(new Date()); /// true 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/isWin.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / isWin 6 | 7 | # Function: isWin() 8 | 9 | > **isWin**(): `boolean` 10 | 11 | 判断是否 Windows 12 | 13 | ## Returns 14 | 15 | `boolean` 16 | 17 | ## Example 18 | 19 | ```ts 20 | isWin(); /// true 21 | ``` 22 | -------------------------------------------------------------------------------- /docs/functions/javaDecrypt.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / javaDecrypt 6 | 7 | # Function: javaDecrypt() 8 | 9 | > **javaDecrypt**(`encryptedData`, `secretKey`?, `secretIv`?): `string` 10 | 11 | 配合使用 Java 对称解密函数 12 | 13 | ## Parameters 14 | 15 | • **encryptedData**: `string` 16 | 17 | 待解密数据 18 | 19 | • **secretKey?**: `string` 20 | 21 | 可选参数，密钥，若不传入则使用默认密钥 SECRET_KEY 22 | 23 | • **secretIv?**: `string` 24 | 25 | 可选参数，向量，若不传入则使用默认向量 SECRET_IV 26 | 27 | ## Returns 28 | 29 | `string` 30 | 31 | ## Example 32 | 33 | ```ts 34 | javaEncrypt("需要加密的字符串"); /// 'SotKrdjNkEIvnQ0OBImYuViSs+WdpjjILvxE1UpNedA=' 35 | javaDecrypt("SotKrdjNkEIvnQ0OBImYuViSs+WdpjjILvxE1UpNedA="); /// '需要加密的字符串' 36 | ``` 37 | -------------------------------------------------------------------------------- /docs/functions/jsonClone.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / jsonClone 6 | 7 | # Function: jsonClone() 8 | 9 | > **jsonClone**(`value`): `any` 10 | 11 | JSON 转字符串式克隆 12 | 13 | ## Parameters 14 | 15 | • **value**: `any` 16 | 17 | 值 18 | 19 | ## Returns 20 | 21 | `any` 22 | 23 | ## Example 24 | 25 | ```ts 26 | jsonClone([1, 2, 2, 3, 3]); /// [1, 2, 2, 3, 3] 27 | jsonClone({a: 1, b: 2}); /// {a: 1, b: 2} 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/keyBoardResize.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / keyBoardResize 6 | 7 | # Function: keyBoardResize() 8 | 9 | > **keyBoardResize**(`downCb`, `upCb`): `any` 10 | 11 | H5 移动端软键盘缩回/弹起回调 12 | `return cancel listener of keyBoardResize` 13 | 14 | ## Parameters 15 | 16 | • **downCb**: `any` 17 | 18 | 缩回回调 19 | 20 | • **upCb**: `any` 21 | 22 | 弹起回调 23 | 24 | ## Returns 25 | 26 | `any` 27 | 28 | ## Example 29 | 30 | ```ts 31 | keyBoardResize(() => { console.log('downCb'); }, () => { console.log('upCb'); }); /// do something 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/leftJoin.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / leftJoin 6 | 7 | # Function: leftJoin() 8 | 9 | > **leftJoin**(`str`, `length`, `char`): `string` 10 | 11 | 左边补某个字符 12 | 13 | ## Parameters 14 | 15 | • **str**: `string` \| `number` 16 | 17 | 字符串 18 | 19 | • **length**: `string` \| `number` = `2` 20 | 21 | • **char**: `string` \| `number` = `0` 22 | 23 | ## Returns 24 | 25 | `string` 26 | 27 | ## Example 28 | 29 | ```ts 30 | leftJoin('1', 3, '0'); /// '001' 31 | leftJoin(0, 3, 1); /// '110' 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/loadStr.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / loadStr 6 | 7 | # Function: loadStr() 8 | 9 | > **loadStr**(`str`, `params`, `emptyStr`?): `string` 10 | 11 | 将字符串中的占位符替换为对应的值 12 | 13 | ## Parameters 14 | 15 | • **str**: `string` 16 | 17 | 原始字符串 18 | 19 | • **params**: `any` 20 | 21 | 参数对象，包含占位符的键值对。 22 | 23 | • **emptyStr?**: `string` 24 | 25 | 对象不存在键值时的占位符，默认不变。 26 | 27 | ## Returns 28 | 29 | `string` 30 | 31 | ## Example 32 | 33 | ```ts 34 | loadStr('hello ${test}', { test: 123 }); // 'hello 123' 35 | loadStr('hello ${test}', undefined); // 'hello ${test}' 36 | loadStr('hello ${test}', undefined, '$'); // 'hello $' 37 | loadStr('hello ${name.first}-${name.last} ${ test }', { name: { first: 'A', last: 'B' }, test: '!' }); // 'hello A-B !' 38 | ``` 39 | -------------------------------------------------------------------------------- /docs/functions/localStorageGet.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / localStorageGet 6 | 7 | # Function: localStorageGet() 8 | 9 | > **localStorageGet**(`key`): `any` 10 | 11 | 获取 localStorage 12 | 13 | ## Parameters 14 | 15 | • **key**: `string` 16 | 17 | 存储 key 18 | 19 | ## Returns 20 | 21 | `any` 22 | 23 | ## Example 24 | 25 | ```ts 26 | localStorageGet("key"); /// 处理过后的 value，不需要再 decode 。 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/localStorageSet.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / localStorageSet 6 | 7 | # Function: localStorageSet() 8 | 9 | > **localStorageSet**(`key`, `value`): `boolean` 10 | 11 | 设置 localStorage 12 | 13 | ## Parameters 14 | 15 | • **key**: `string` 16 | 17 | 存储 key 18 | 19 | • **value**: `any` 20 | 21 | 存储 value，value === null|undefined 清除数据。 22 | 23 | ## Returns 24 | 25 | `boolean` 26 | 27 | ## Example 28 | 29 | ```ts 30 | localStorageSet("key", "value"); /// 存储时不需要处理数据，value === null|undefined 清除数据。(boolean) 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/functions/log.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / log 6 | 7 | # Function: log() 8 | 9 | > **log**(...`args`): `string` 10 | 11 | 在页面上打印数据，我们打包通常会设置清除 console，使用此函数打印关键信息就不会被清除啦。 12 | 13 | ## Parameters 14 | 15 | • ...**args**: `any`[] 16 | 17 | 打印数据 rest 参数 18 | 19 | ## Returns 20 | 21 | `string` 22 | 23 | ## Example 24 | 25 | ```ts 26 | log([1, 2, 2, 3, 3], {a: 1, b: 2}, 'test', true); /// 打印数据 27 | log('danger'); /// 打印数据 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/logRunTime.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / logRunTime 6 | 7 | # Function: logRunTime() 8 | 9 | > **logRunTime**(`fn`, `timeKey`): `void` 10 | 11 | 打印某个函数运行时间 12 | 13 | ## Parameters 14 | 15 | • **fn**: `any` 16 | 17 | 方法函数 18 | 19 | • **timeKey**: `string` 20 | 21 | 打印时间记录关键 key 22 | 23 | ## Returns 24 | 25 | `void` 26 | 27 | ## Example 28 | 29 | ```ts 30 | logRunTime(() => [1, 2, 3].reduce(...)); 31 | logRunTime(() => [1, 2, 3].reduce(...), 'timeKey'); 32 | logRunTime(async () => { await fun1(); await fun2(); }); 33 | logRunTime($promiseReturnFunction); 34 | logRunTime(new Promise((resolve, reject) => { setTimeout(() => resolve('test'), 1000) })); 35 | ``` 36 | -------------------------------------------------------------------------------- /docs/functions/markNumber.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / markNumber 6 | 7 | # Function: markNumber() 8 | 9 | > **markNumber**(`value`): `string` 10 | 11 | 转换数字为大致数字描述 12 | 13 | ## Parameters 14 | 15 | • **value**: `number` 16 | 17 | 数值 18 | 19 | ## Returns 20 | 21 | `string` 22 | 23 | ## Example 24 | 25 | ```ts 26 | markNumber(10000123111); /// '100.00 亿' 27 | markNumber(12345); /// '1.2 万' 28 | markNumber(123); /// '123' 29 | ``` 30 | -------------------------------------------------------------------------------- /docs/functions/maskString.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / maskString 6 | 7 | # Function: maskString() 8 | 9 | > **maskString**(`str`): `string` 10 | 11 | 字符串脱敏(biugle 自定义规则) 12 | 13 | ## Parameters 14 | 15 | • **str**: `string` 16 | 17 | 字符串 18 | 19 | ## Returns 20 | 21 | `string` 22 | 23 | ## Example 24 | 25 | ```ts 26 | maskString(undefined); /// '-' 27 | maskString('13579246810'); /// '135****6810' 28 | maskString('王小二'); /// '王***二' 29 | maskString('123456789'); /// '123****89' 30 | maskString('130223199809282927'); /// '13022********927' 31 | maskString('广东省深圳市龙华区'); /// 广东省****华区' 32 | maskString('广东省深圳市福田区福田保税区xxx小区xxx单元x栋x楼xxx号'); /// '广东省深圳市福田区******xx号' 33 | ``` 34 | -------------------------------------------------------------------------------- /docs/functions/md5.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / md5 6 | 7 | # Function: md5() 8 | 9 | > **md5**(`str`): `string` 10 | 11 | md5 加密函数 12 | 13 | ## Parameters 14 | 15 | • **str**: `string` 16 | 17 | 需要加密的字符串 18 | 19 | ## Returns 20 | 21 | `string` 22 | 23 | ## Example 24 | 25 | ```ts 26 | md5("value"); /// 加密后的字符串 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/ms.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / ms 6 | 7 | # Function: ms() 8 | 9 | > **ms**(`str`): `string` \| `number` 10 | 11 | 毫秒转换 12 | 13 | ## Parameters 14 | 15 | • **str**: `any` 16 | 17 | 值 18 | 19 | ## Returns 20 | 21 | `string` \| `number` 22 | 23 | ## Example 24 | 25 | ```ts 26 | ms('1s'); /// 1000 27 | ms('1m'); /// 60000 28 | ms('1.5h'); /// 5400000 29 | ms('1d'); /// 86400000 30 | ms('1y'); /// 31557600000 31 | ms('1000'); /// 1000 32 | ms(1500); /// '1.5s' 33 | ms(60000); /// '1m' 34 | ``` 35 | -------------------------------------------------------------------------------- /docs/functions/obj2buf.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / obj2buf 6 | 7 | # Function: obj2buf() 8 | 9 | > **obj2buf**(`data`, `transfer`): `any` 10 | 11 | object to buffer 12 | 13 | ## Parameters 14 | 15 | • **data**: `any` 16 | 17 | object 数据 18 | 19 | • **transfer**: `any` 20 | 21 | 转换器 22 | 23 | ## Returns 24 | 25 | `any` 26 | 27 | ## Example 28 | 29 | ```ts 30 | const _protoBuffer = _proto.lookupType('MonitorMessage'); 31 | const bufferData = obj2buf(obj, _protoBuffer); 32 | console.log(bufferData); 33 | webSocket.send(bufferData); 34 | ``` 35 | -------------------------------------------------------------------------------- /docs/functions/observeResource.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / observeResource 6 | 7 | # Function: observeResource() 8 | 9 | > **observeResource**(`callback`?): `void` 10 | 11 | 监听资源找不到的情况，刷新页面。 12 | 13 | ## Parameters 14 | 15 | • **callback?**: `any` 16 | 17 | ## Returns 18 | 19 | `void` 20 | 21 | ## Example 22 | 23 | ```ts 24 | observeResource(() => console.log('Refreshing')); /// 找不到资源时输出 "Refreshing" 25 | observeResource(); /// 找不到资源时刷新页面 26 | ``` 27 | -------------------------------------------------------------------------------- /docs/functions/offDefaultEvent.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / offDefaultEvent 6 | 7 | # Function: offDefaultEvent() 8 | 9 | > **offDefaultEvent**(`event`): `boolean` 10 | 11 | 阻止冒泡事件&阻止默认行为&阻止事件捕获 12 | 13 | ## Parameters 14 | 15 | • **event**: `any` 16 | 17 | 事件 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | offDefaultEvent(event); /// 阻止冒泡事件&阻止默认行为&阻止事件捕获 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/onClick2MoreClick.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / onClick2MoreClick 6 | 7 | # Function: onClick2MoreClick() 8 | 9 | > **onClick2MoreClick**(`delay`, ...`events`): `any` 10 | 11 | 单击事件转换为多击事件 12 | Author: WuXingHeng 13 | 14 | ## Parameters 15 | 16 | • **delay**: `number` = `300` 17 | 18 | 点击间隔 19 | 20 | • ...**events**: `any`[] 21 | 22 | 事件多击 rest 参数 23 | 24 | ## Returns 25 | 26 | `any` 27 | 28 | ## Example 29 | 30 | ```ts 31 | dom.onclick = onClick2MoreClick(300, clickOneCallBack, clickTwoCallBack, clickThreeCallBack, clickFourCallBack); /// void 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/onResize.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / onResize 6 | 7 | # Function: onResize() 8 | 9 | > **onResize**(`foo`): `any` 10 | 11 | 设置 resize 时的监听函数，默认重新加载页面。 12 | 返回取消该监听的函数 return cancel 13 | 14 | ## Parameters 15 | 16 | • **foo**: `any` 17 | 18 | 函数 19 | 20 | ## Returns 21 | 22 | `any` 23 | 24 | ## Example 25 | 26 | ```ts 27 | onResize(); /// cancel 当前 listener 的 function 28 | onResize('resize', () => { console.log('resize'); }); /// cancel 当前 listener 的 function 29 | ``` 30 | -------------------------------------------------------------------------------- /docs/functions/openFullscreen.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / openFullscreen 6 | 7 | # Function: openFullscreen() 8 | 9 | > **openFullscreen**(`element`): `void` 10 | 11 | 开启全屏 12 | 13 | ## Parameters 14 | 15 | • **element**: `any` = `document.body` 16 | 17 | 元素 18 | 19 | ## Returns 20 | 21 | `void` 22 | 23 | ## Example 24 | 25 | ```ts 26 | openFullscreen(); /// 开启全屏 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/parseJSON.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / parseJSON 6 | 7 | # Function: parseJSON() 8 | 9 | > **parseJSON**(`value`): `any` 10 | 11 | 解析 JSON 字符串 12 | 13 | ## Parameters 14 | 15 | • **value**: `any` 16 | 17 | 需要解析的值 18 | 19 | ## Returns 20 | 21 | `any` 22 | 23 | ## Example 24 | 25 | ```ts 26 | parseJSON('{"name":"leo", "age":20}'); /// {"name": "leo", "age": 20} 27 | parseJSON(123); /// 123 28 | parseJSON(true); /// true 29 | parseJSON(null); /// null 30 | parseJSON('test error'); /// null 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/functions/playAudio.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / playAudio 6 | 7 | # Function: playAudio() 8 | 9 | > **playAudio**(`input`): `void` 10 | 11 | 播放音频 12 | 13 | ## Parameters 14 | 15 | • **input**: `string` 16 | 17 | 声音类型或者音频路径 18 | 19 | ## Returns 20 | 21 | `void` 22 | 23 | ## Example 24 | 25 | ```ts 26 | playAudio('path/to/custom.mp3'); 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/printDom.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / printDom 6 | 7 | # Function: printDom() 8 | 9 | > **printDom**(`selector`, `styles`?): `any` 10 | 11 | 在打印预览中打印指定元素，并设置样式。 12 | 需在浏览器打印设置中-更多设置-开启背景与图形打印选项 13 | 14 | ## Parameters 15 | 16 | • **selector**: `string` 17 | 18 | 要打印的元素的 CSS 选择器。 19 | 20 | • **styles?** 21 | 22 | iframe 的 style 配置对象。 23 | 24 | • **styles.bodyStyle?**: `any` 25 | 26 | • **styles.htmlStyle?**: `any` 27 | 28 | • **styles.iframeStyle?**: `any` 29 | 30 | ## Returns 31 | 32 | `any` 33 | 34 | ## Example 35 | 36 | ```ts 37 | printElement('#print-table', { 38 | bodyStyle: { 39 | padding: '10px', 40 | backgroundColor: 'red', 41 | }, 42 | }); 43 | ``` 44 | -------------------------------------------------------------------------------- /docs/functions/px2rem.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / px2rem 6 | 7 | # Function: px2rem() 8 | 9 | > **px2rem**(`px`): `number` 10 | 11 | px 转 rem 12 | 13 | ## Parameters 14 | 15 | • **px**: `number` 16 | 17 | 像素值 18 | 19 | ## Returns 20 | 21 | `number` 22 | 23 | ## Example 24 | 25 | ```ts 26 | px2rem(30); /// 转化后的 rem 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/qsParse.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / qsParse 6 | 7 | # Function: qsParse() 8 | 9 | > **qsParse**(`url`?, `key`?): `any` 10 | 11 | 获取 query string 参数转对象 12 | 13 | ## Parameters 14 | 15 | • **url?**: `string` 16 | 17 | query string 18 | 19 | • **key?**: `string` 20 | 21 | 参数名 22 | 23 | ## Returns 24 | 25 | `any` 26 | 27 | ## Example 28 | 29 | ```ts 30 | qsParse('start=0&count=20&x=1&x=2&x=3', 'x'); /// [1, 2, 3] 31 | qsParse('http://a.cn/123/test?start=0&count=20&x=1&x=2&x=3#123'); /// { start: '0', count: '20', x: [1, 2, 3], '#': 123, '_': 'test', '/': 'test?start=0&count=20&x=1&x=2&x=3#123' } 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/removeCookie.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / removeCookie 6 | 7 | # Function: removeCookie() 8 | 9 | > **removeCookie**(`key`): `void` 10 | 11 | Remove Cookie 12 | 13 | ## Parameters 14 | 15 | • **key**: `string` 16 | 17 | Cookie key 18 | 19 | ## Returns 20 | 21 | `void` 22 | 23 | ## Example 24 | 25 | ```ts 26 | removeCookie('name'); /// 删除 name 对应的 Cookie 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/removeTag.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / removeTag 6 | 7 | # Function: removeTag() 8 | 9 | > **removeTag**(`str`): `string` 10 | 11 | 去除字符串中的元素标记 12 | 13 | ## Parameters 14 | 15 | • **str**: `string` 16 | 17 | 字符串 18 | 19 | ## Returns 20 | 21 | `string` 22 | 23 | ## Example 24 | 25 | ```ts 26 | removeTag('
Hello Wife
'); /// 'Hello Wife' 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/renderTemplate.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / renderTemplate 6 | 7 | # Function: renderTemplate() 8 | 9 | > **renderTemplate**(`content`, `replacements`): `string` 10 | 11 | 简单的模板渲染引擎 12 | 使用自定义模板渲染字符串内容 13 | 支持条件渲染、循环、嵌套变量、默认值以及简单占位符替换 14 | 15 | ## Parameters 16 | 17 | • **content**: `string` 18 | 19 | 原始模板内容 20 | 21 | • **replacements**: `any` 22 | 23 | 要替换的值-对象 24 | 25 | ## Returns 26 | 27 | `string` 28 | 29 | ## Example 30 | 31 | ```ts 32 | /// https://github.com/biugle/js-xcmd/blob/main/utils/template.js 33 | ``` 34 | 35 | ## Link 36 | 37 | https://github.com/biugle/js-xcmd/blob/main/utils/template.js 38 | -------------------------------------------------------------------------------- /docs/functions/repeat.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / repeat 6 | 7 | # Function: repeat() 8 | 9 | > **repeat**(`str`, `n`): `string` 10 | 11 | 字符串 repeat 12 | 13 | ## Parameters 14 | 15 | • **str**: `string` 16 | 17 | 字符串 18 | 19 | • **n**: `number` = `1` 20 | 21 | ## Returns 22 | 23 | `string` 24 | 25 | ## Example 26 | 27 | ```ts 28 | repeat('*'); /// '*' 29 | repeat('*', 3); /// '***' 30 | ``` 31 | -------------------------------------------------------------------------------- /docs/functions/retry.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / retry 6 | 7 | # Function: retry() 8 | 9 | > **retry**(`promise`, `count`, `delay`): `Promise`\<`unknown`\> 10 | 11 | Promise 重试 12 | 13 | ## Parameters 14 | 15 | • **promise**: `Promise`\<`any`\> 16 | 17 | promise 18 | 19 | • **count**: `number` = `0` 20 | 21 | 次数 22 | 23 | • **delay**: `number` = `0` 24 | 25 | 延迟时间 26 | 27 | ## Returns 28 | 29 | `Promise`\<`unknown`\> 30 | 31 | ## Example 32 | 33 | ```ts 34 | retry(() => Promise.reject(new Error('error')), 3); /// Promise.reject(new Error('error')) 执行 3 次 35 | ``` 36 | -------------------------------------------------------------------------------- /docs/functions/rightJoin.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / rightJoin 6 | 7 | # Function: rightJoin() 8 | 9 | > **rightJoin**(`str`, `length`, `char`): `string` 10 | 11 | 右边补某个字符 12 | 13 | ## Parameters 14 | 15 | • **str**: `string` \| `number` 16 | 17 | 字符串 18 | 19 | • **length**: `string` \| `number` = `2` 20 | 21 | • **char**: `string` \| `number` = `0` 22 | 23 | ## Returns 24 | 25 | `string` 26 | 27 | ## Example 28 | 29 | ```ts 30 | rightJoin('1', 3, 'x'); /// '1xx' 31 | rightJoin(0, 3, 1); /// '011' 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/rip.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / rip 6 | 7 | # Function: rip() 8 | 9 | > **rip**(): `void` 10 | 11 | 页面灰白屏幕 12 | 13 | ## Returns 14 | 15 | `void` 16 | 17 | ## Example 18 | 19 | ```ts 20 | rip(); /// 页面灰白 21 | ``` 22 | -------------------------------------------------------------------------------- /docs/functions/round.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / round 6 | 7 | # Function: round() 8 | 9 | > **round**(`number`, `d`): `number` 10 | 11 | 四舍五入 12 | `const toFixed = (n, fixed) => ~~(Math.pow(10, fixed) * n) / Math.pow(10, fixed);` 13 | `const toPrecision = (number, c) => (Math.round(+number * 10 ** c) / 10 ** c).toFixed(c);` 14 | 15 | ## Parameters 16 | 17 | • **number**: `any` 18 | 19 | 浮点数 20 | 21 | • **d**: `number` 22 | 23 | 保留小数位 24 | 25 | ## Returns 26 | 27 | `number` 28 | 29 | ## Example 30 | 31 | ```ts 32 | round(1.2345, 2); /// 1.23 33 | round(0.355, 2); /// 0.36 34 | round(1.005, 2); /// 1.01 35 | ``` 36 | -------------------------------------------------------------------------------- /docs/functions/safeDecodeURI.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / safeDecodeURI 6 | 7 | # Function: safeDecodeURI() 8 | 9 | > **safeDecodeURI**(`s`): `string` 10 | 11 | 安全解码 URI，遇到错误时返回原始字符串。 12 | 13 | ## Parameters 14 | 15 | • **s**: `string` 16 | 17 | 要解码的 URI 。 18 | 19 | ## Returns 20 | 21 | `string` 22 | 23 | ## Example 24 | 25 | ```ts 26 | safeDecodeURI('Hello%20World'); // 'Hello World' 27 | safeDecodeURI('%E4%BD%A0%E5%A5%BD'); // '你好' 28 | safeDecodeURI('%E4%BD%A0%E5%A5'); // '%E4%BD%A0%E5%A5' （无效的 URI 片段） 29 | safeDecodeURI('%'); // '%' （无效的 URI 片段） 30 | ``` 31 | -------------------------------------------------------------------------------- /docs/functions/safeEncodeURI.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / safeEncodeURI 6 | 7 | # Function: safeEncodeURI() 8 | 9 | > **safeEncodeURI**(`s`): `string` 10 | 11 | 安全编码 URI，遇到错误时返回原始字符串。 12 | 13 | ## Parameters 14 | 15 | • **s**: `string` 16 | 17 | 要编码的字符串。 18 | 19 | ## Returns 20 | 21 | `string` 22 | 23 | ## Example 24 | 25 | ```ts 26 | safeEncodeURI('Hello World'); // 'Hello%20World' 27 | safeEncodeURI('你好'); // '%E4%BD%A0%E5%A5%BD' 28 | safeEncodeURI('https://example.com?param=1¶m=2'); // 'https%3A%2F%2Fexample.com%3Fparam%3D1%26param%3D2' 29 | safeEncodeURI('特殊字符 !@#'); // '%E7%89%B9%E6%AE%8A%E5%AD%97%E7%AC%A6%20%21%40%23' 30 | ``` 31 | -------------------------------------------------------------------------------- /docs/functions/same.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / same 6 | 7 | # Function: same() 8 | 9 | > **same**(`valueA`, `valueB`): `boolean` 10 | 11 | 两个数值是否有相同的值（交集） 12 | 13 | ## Parameters 14 | 15 | • **valueA**: `string` \| `any`[] 16 | 17 | 值 A 18 | 19 | • **valueB**: `string` \| `any`[] 20 | 21 | 值 B 22 | 23 | ## Returns 24 | 25 | `boolean` 26 | 27 | ## Example 28 | 29 | ```ts 30 | same(['admin','manager','user','viewer','guest'], ['admin','user']); /// true 31 | same(['admin','manager','user','viewer','guest'], 'admin'); /// true 32 | same('admin', ['admin','user']); /// true 33 | same('admin', 'admin'); /// true 34 | same('admin', 'admins'); /// false 35 | same('admins', 'admin'); /// false 36 | ``` 37 | -------------------------------------------------------------------------------- /docs/functions/saveAs.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / saveAs 6 | 7 | # Function: saveAs() 8 | 9 | > **saveAs**(`blob`, `filename`?): `void` 10 | 11 | 将 Blob 对象保存为文件并下载。 12 | 13 | ## Parameters 14 | 15 | • **blob**: `Blob` 16 | 17 | 要保存的 Blob 对象。 18 | 19 | • **filename?**: `string` 20 | 21 | 可选。保存的文件名。 22 | 23 | ## Returns 24 | 25 | `void` 26 | 27 | ## Example 28 | 29 | ```ts 30 | const blob = new Blob(['Hello, World!'], { type: 'text/plain' }); 31 | saveAs(blob, 'hello.txt'); // 下载文件名为 'hello.txt' 32 | const jsonBlob = new Blob([JSON.stringify({ a: 1, b: 2 }, null, 2)], { type: 'application/json' }); 33 | saveAs(jsonBlob, 'data.json'); // 下载文件名为 'data.json' 34 | ``` 35 | -------------------------------------------------------------------------------- /docs/functions/scrollToView.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / scrollToView 6 | 7 | # Function: scrollToView() 8 | 9 | > **scrollToView**(`dom`, `targetVal`): `void` 10 | 11 | 将元素滚动到视野范围 12 | 13 | ## Parameters 14 | 15 | • **dom**: `any` = `document.documentElement` 16 | 17 | 元素对象 18 | 19 | • **targetVal**: `"center"` \| `"start"` \| `"end"` \| `"nearest"` = `'center'` 20 | 21 | 'start' | 'end' | 'center' | 'nearest' 22 | 23 | ## Returns 24 | 25 | `void` 26 | 27 | ## Example 28 | 29 | ```ts 30 | scrollIntoView(document.querySelector('.test')); /// test 元素滚动到视野范围 31 | scrollIntoView(document.querySelector('.test'), 'start'); /// test 元素滚动到视野范围顶部 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/scrollXTo.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / scrollXTo 6 | 7 | # Function: scrollXTo() 8 | 9 | > **scrollXTo**(`targetVal`, `callback`, `dom`): `void` 10 | 11 | X 轴滚动到指定位置 12 | 13 | ## Parameters 14 | 15 | • **targetVal**: `number` \| `"start"` \| `"end"` 16 | 17 | 'start' | 'end' | number 18 | 19 | • **callback**: `any` 20 | 21 | 回调 22 | 23 | • **dom**: `any` = `document.documentElement` 24 | 25 | 元素对象 26 | 27 | ## Returns 28 | 29 | `void` 30 | 31 | ## Example 32 | 33 | ```ts 34 | scrollXTo(0); /// 滚动到左侧 35 | scrollXTo('start', null, document.documentElement); /// 滚动到左侧 36 | scrollXTo('end', (percent) => console.log(percent), document.querySelector('body')); /// 滚动到右侧 37 | ``` 38 | -------------------------------------------------------------------------------- /docs/functions/scrollYTo.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / scrollYTo 6 | 7 | # Function: scrollYTo() 8 | 9 | > **scrollYTo**(`targetVal`, `callback`, `dom`): `void` 10 | 11 | Y 轴滚动到指定位置 12 | 13 | ## Parameters 14 | 15 | • **targetVal**: `number` \| `"start"` \| `"end"` 16 | 17 | 'start' | 'end' | number 18 | 19 | • **callback**: `any` 20 | 21 | 回调 22 | 23 | • **dom**: `any` = `document.documentElement` 24 | 25 | 元素对象 26 | 27 | ## Returns 28 | 29 | `void` 30 | 31 | ## Example 32 | 33 | ```ts 34 | scrollYTo(0); /// 滚动到顶部 35 | scrollYTo('start', null, document.documentElement); /// 滚动到顶部 36 | scrollYTo('end', (percent) => console.log(percent), document.querySelector('body')); /// 滚动到底部 37 | ``` 38 | -------------------------------------------------------------------------------- /docs/functions/sendNotification.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / sendNotification 6 | 7 | # Function: sendNotification() 8 | 9 | > **sendNotification**(`msg`, `title`?, `options`?): `void` 10 | 11 | 发送 Notification 12 | 13 | ## Parameters 14 | 15 | • **msg**: `string` 16 | 17 | • **title?**: `string` 18 | 19 | • **options?**: `object` \| `NotificationOptions` 20 | 21 | ## Returns 22 | 23 | `void` 24 | 25 | ## Example 26 | 27 | ```ts 28 | sendNotification('测试通知', '测试标题', {...options}); /// 发送成功/失败 29 | ``` 30 | -------------------------------------------------------------------------------- /docs/functions/sendWsMsg.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / sendWsMsg 6 | 7 | # Function: sendWsMsg() 8 | 9 | > **sendWsMsg**(`message`, `isJSONEncode`): `boolean` 10 | 11 | 发送消息 12 | 13 | ## Parameters 14 | 15 | • **message**: `any` 16 | 17 | 消息 18 | 19 | • **isJSONEncode**: `boolean` = `false` 20 | 21 | 是否对数据 JSON 序列化 22 | 23 | ## Returns 24 | 25 | `boolean` 26 | 27 | ## Example 28 | 29 | ```ts 30 | sendWsMsg({ type: 'login', data: { username: 'admin', password: '123456' }}, true); /// true/false 31 | sendWsMsg('testMsg'); /// true/false 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/sessionStorageGet.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / sessionStorageGet 6 | 7 | # Function: sessionStorageGet() 8 | 9 | > **sessionStorageGet**(`key`): `any` 10 | 11 | 获取 sessionStorage 12 | 13 | ## Parameters 14 | 15 | • **key**: `string` 16 | 17 | 存储 key 18 | 19 | ## Returns 20 | 21 | `any` 22 | 23 | ## Example 24 | 25 | ```ts 26 | sessionStorageGet("key"); /// 处理过后的 value，不需要再 decode 。 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/sessionStorageSet.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / sessionStorageSet 6 | 7 | # Function: sessionStorageSet() 8 | 9 | > **sessionStorageSet**(`key`, `value`): `boolean` 10 | 11 | 设置 sessionStorage 12 | 13 | ## Parameters 14 | 15 | • **key**: `string` 16 | 17 | 存储 key 18 | 19 | • **value**: `any` 20 | 21 | 存储 value，value === null|undefined 清除数据。 22 | 23 | ## Returns 24 | 25 | `boolean` 26 | 27 | ## Example 28 | 29 | ```ts 30 | sessionStorageSet("key", "value"); /// 存储时不需要处理数据，value === null|undefined 清除数据。 31 | ``` 32 | -------------------------------------------------------------------------------- /docs/functions/setCookie.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / setCookie 6 | 7 | # Function: setCookie() 8 | 9 | > **setCookie**(`key`, `value`, `expires`): `void` 10 | 11 | Set Cookie 12 | 13 | ## Parameters 14 | 15 | • **key**: `string` 16 | 17 | Cookie key 18 | 19 | • **value**: `any` 20 | 21 | Cookie value 22 | 23 | • **expires**: `number` 24 | 25 | Cookie expires 26 | 27 | ## Returns 28 | 29 | `void` 30 | 31 | ## Example 32 | 33 | ```ts 34 | setCookie('name', 'value', 1); /// 设置 name 对应的 Cookie 值 35 | ``` 36 | -------------------------------------------------------------------------------- /docs/functions/setEncodeStorage.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / setEncodeStorage 6 | 7 | # Function: setEncodeStorage() 8 | 9 | > **setEncodeStorage**(`key`, `value`, `isLocal`): `boolean` 10 | 11 | 设置 Storage 加密数据 12 | 13 | ## Parameters 14 | 15 | • **key**: `string` 16 | 17 | 存储 key 18 | 19 | • **value**: `string` 20 | 21 | 存储 value 字符串，value === null|undefined 清除数据。 22 | 23 | • **isLocal**: `boolean` = `true` 24 | 25 | 是否 localStorage 26 | 27 | ## Returns 28 | 29 | `boolean` 30 | 31 | ## Example 32 | 33 | ```ts 34 | setEncodeStorage("key", "value"); /// 存储时不需要处理数据，自动加密，value === null|undefined 清除数据。(boolean) 35 | ``` 36 | -------------------------------------------------------------------------------- /docs/functions/setEventListener.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / setEventListener 6 | 7 | # Function: setEventListener() 8 | 9 | > **setEventListener**(`eventKey`, `foo`, `once`, `dom`): `any` 10 | 11 | 设置监听函数 12 | 返回取消该监听的函数 return cancel 13 | 14 | ## Parameters 15 | 16 | • **eventKey**: `string` 17 | 18 | 事件 key 19 | 20 | • **foo**: `any` 21 | 22 | 函数 23 | 24 | • **once**: `boolean` = `false` 25 | 26 | 是否只触发一次 27 | 28 | • **dom**: `any` = `window` 29 | 30 | document.querySelector('.xxx') 31 | 32 | ## Returns 33 | 34 | `any` 35 | 36 | ## Example 37 | 38 | ```ts 39 | setEventListener('resize', () => { console.log('resize'); }); /// cancel 当前 listener 的 function 40 | ``` 41 | -------------------------------------------------------------------------------- /docs/functions/setIcon.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / setIcon 6 | 7 | # Function: setIcon() 8 | 9 | > **setIcon**(`iconLink`): `void` 10 | 11 | 设置网页 icon 12 | 13 | ## Parameters 14 | 15 | • **iconLink**: `string` 16 | 17 | icon 链接 18 | 19 | ## Returns 20 | 21 | `void` 22 | 23 | ## Example 24 | 25 | ```ts 26 | setIcon('/favicon.ico') 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/setWsBinaryType.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / setWsBinaryType 6 | 7 | # Function: setWsBinaryType() 8 | 9 | > **setWsBinaryType**(`binaryType`): `boolean` 10 | 11 | `设置 websocket binaryType default: 'blob'` 12 | 13 | ## Parameters 14 | 15 | • **binaryType**: `any` = `'arraybuffer'` 16 | 17 | `BinaryType 二进制类型 default: 'arraybuffer'` 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | 23 | ## Example 24 | 25 | ```ts 26 | setWsBinaryType(); /// true/false 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/sha1.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / sha1 6 | 7 | # Function: sha1() 8 | 9 | > **sha1**(`str`): `string` 10 | 11 | sha1 加密函数 12 | 13 | ## Parameters 14 | 15 | • **str**: `string` 16 | 17 | 需要加密的字符串 18 | 19 | ## Returns 20 | 21 | `string` 22 | 23 | ## Example 24 | 25 | ```ts 26 | sha1("value"); /// 加密后的字符串 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/sha256.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / sha256 6 | 7 | # Function: sha256() 8 | 9 | > **sha256**(`str`): `string` 10 | 11 | sha256 加密函数 12 | 13 | ## Parameters 14 | 15 | • **str**: `string` 16 | 17 | 需要加密的字符串 18 | 19 | ## Returns 20 | 21 | `string` 22 | 23 | ## Example 24 | 25 | ```ts 26 | sha256("value"); /// 加密后的字符串 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/showProcess.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / showProcess 6 | 7 | # Function: showProcess() 8 | 9 | > **showProcess**(`element`): () => `void` 10 | 11 | 展示水滴加载动画 12 | 13 | ## Parameters 14 | 15 | • **element**: `any` 16 | 17 | 元素 18 | 19 | ## Returns 20 | 21 | `Function` 22 | 23 | ### Returns 24 | 25 | `void` 26 | 27 | ## Example 28 | 29 | ```ts 30 | const hideProcess = showProcess(myElement); /// 在元素中显示水滴加载动画 31 | hideProcess(); /// 隐藏水滴加载动画 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/showToast.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / showToast 6 | 7 | # Function: showToast() 8 | 9 | > **showToast**(`options`): `HTMLDivElement` 10 | 11 | 显示 Toast 12 | `export function showToast(options: xToastOptions);` 13 | 14 | ## Parameters 15 | 16 | • **options**: [`xToastOptions`](../type-aliases/xToastOptions.md) 17 | 18 | 显示配置 19 | 20 | ## Returns 21 | 22 | `HTMLDivElement` 23 | 24 | ## Example 25 | 26 | ```ts 27 | showToast({ type: 'success', content: '这是一个演示 Toast' }); /// 显示 success 类型的 toast 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/showVar.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / showVar 6 | 7 | # Function: showVar() 8 | 9 | > **showVar**(`value`): `any` 10 | 11 | 在页面上显示某个值 12 | 13 | ## Parameters 14 | 15 | • **value**: `any` 16 | 17 | 值 18 | 19 | ## Returns 20 | 21 | `any` 22 | 23 | ## Example 24 | 25 | ```ts 26 | showVar([1, 2, 2, 3, 3]); /// 显示序列化之后的数据 27 | showVar({a: 1, b: 2}); /// 显示序列化之后的数据 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/sleep.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / sleep 6 | 7 | # Function: sleep() 8 | 9 | > **sleep**(`milliseconds`, `returnValue`?): `Promise`\<`any`\> 10 | 11 | 睡眠指定时间，或者 mock 接口数据。 12 | 13 | ## Parameters 14 | 15 | • **milliseconds**: `undefined` \| `number` 16 | 17 | 睡眠时间 18 | 19 | • **returnValue?**: `any` 20 | 21 | 返回值 22 | 23 | ## Returns 24 | 25 | `Promise`\<`any`\> 26 | 27 | ## Example 28 | 29 | ```ts 30 | await sleep(1000); /// 等待 1000 毫秒再执行后面的 31 | await sleep(1000, '1'); /// 等待 1000 毫秒再执行后面的，并且返回 '1'，方便 mock 数据。 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/slugify.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / slugify 6 | 7 | # Function: slugify() 8 | 9 | > **slugify**(`str`, `replacement`?): `string` 10 | 11 | Slug 化字符串 URL，将字符串转换为 URL 友好的格式。 12 | 13 | ## Parameters 14 | 15 | • **str**: `string` 16 | 17 | 字符串值 18 | 19 | • **replacement?** 20 | 21 | 替换字符串映射 22 | 23 | ## Returns 24 | 25 | `string` 26 | 27 | ## Example 28 | 29 | ```ts 30 | slugify('I LOVE OQM'); /// 'I_LOVE_OQM' 31 | slugify('I LOVE OQM', { ' ': '-' }); /// 'I-LOVE-OQM' 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/sortBy.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / sortBy 6 | 7 | # Function: sortBy() 8 | 9 | > **sortBy**(`keys`?, `isAscend`?): `any` 10 | 11 | 返回排序回调函数(也支持中文、多个字段、混合类型) 12 | 13 | ## Parameters 14 | 15 | • **keys?**: `string` \| `string`[] 16 | 17 | 排序的字段/集合 18 | 19 | • **isAscend?**: `boolean` = `true` 20 | 21 | 是否升序 22 | 23 | ## Returns 24 | 25 | `any` 26 | 27 | ## Example 28 | 29 | ```ts 30 | ['a', '3', 1, 2, 'b'].sort(sortBy('', false)); /// ['b', 'a', '3', 2, 1] 31 | ['a', '3', 1, 2, 'b'].sort(sortBy()); /// [1, 2, '3', 'a', 'b'] 32 | sortBy('createDt'); /// 按照 createDt 升序排列 33 | sortBy(['name', 'age'], false); /// 按照 name + age 降序排列 34 | ``` 35 | -------------------------------------------------------------------------------- /docs/functions/sortCallBack.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / sortCallBack 6 | 7 | # Function: sortCallBack() 8 | 9 | > **sortCallBack**(`key`, `isAscend`): `any` 10 | 11 | 返回排序回调函数(支持中文，不支持一级数据与混合类型。) 12 | 13 | ## Parameters 14 | 15 | • **key**: `string` 16 | 17 | 排序的字段 18 | 19 | • **isAscend**: `boolean` = `true` 20 | 21 | 是否升序 22 | 23 | ## Returns 24 | 25 | `any` 26 | 27 | ## Example 28 | 29 | ```ts 30 | sortCallBack('createDt', true); /// 按照 createDt 升序排列 31 | const arr = [{name: '666'}, {name: '333'}] 32 | arr.sort(sortCallBack('name')); /// [{name: '333'}, {name: '666'}] 33 | arr.sort(sortCallBack('name', false)); /// [{name: '666'}, {name: '333'}] 34 | ``` 35 | -------------------------------------------------------------------------------- /docs/functions/sortJSON.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / sortJSON 6 | 7 | # Function: sortJSON() 8 | 9 | > **sortJSON**(`obj`): `string` 10 | 11 | ## Parameters 12 | 13 | • **obj**: `any` 14 | 15 | ## Returns 16 | 17 | `string` 18 | -------------------------------------------------------------------------------- /docs/functions/stackSticky.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / stackSticky 6 | 7 | # Function: stackSticky() 8 | 9 | > **stackSticky**(`selectors`, `direction`): `void` 10 | 11 | 自动堆叠 12 | 13 | ## Parameters 14 | 15 | • **selectors**: `string` 16 | 17 | 选择器字符串 18 | 19 | • **direction**: `string` = `'top'` 20 | 21 | 堆叠方向 22 | 23 | ## Returns 24 | 25 | `void` 26 | 27 | ## Example 28 | 29 | ```ts 30 | stackSticky('.stack', 'top'); /// 所有 .stack 元素自动在 top 上堆叠 31 | stackSticky('.stack', 'left'); /// 所有 .stack 元素自动在 left 上堆叠 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/str2html.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / str2html 6 | 7 | # Function: str2html() 8 | 9 | > **str2html**(`str`): `string` 10 | 11 | 字符串转实体字符 12 | 13 | ## Parameters 14 | 15 | • **str**: `string` 16 | 17 | 字符串 18 | 19 | ## Returns 20 | 21 | `string` 22 | 23 | ## Example 24 | 25 | ```ts 26 | str2html('<>&"'); /// '<>&"' 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/str2unicode.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / str2unicode 6 | 7 | # Function: str2unicode() 8 | 9 | > **str2unicode**(`value`): `string` 10 | 11 | unicode 转字符 12 | 13 | ## Parameters 14 | 15 | • **value**: `string` 16 | 17 | unicode 字符串 18 | 19 | ## Returns 20 | 21 | `string` 22 | 23 | ## Example 24 | 25 | ```ts 26 | str2unicode("\\u6211\\u662f\\u8001a"); /// '我是老a' 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/stringifyJSON.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / stringifyJSON 6 | 7 | # Function: stringifyJSON() 8 | 9 | > **stringifyJSON**(`value`): `string` 10 | 11 | 将任意值序列化为 JSON 字符串，处理无法序列化的情况。 12 | 13 | ## Parameters 14 | 15 | • **value**: `any` 16 | 17 | 需要序列化的值 18 | 19 | ## Returns 20 | 21 | `string` 22 | 23 | ## Example 24 | 25 | ```ts 26 | stringifyJSON({ name: 'leo', age: 20 }); /// '{"name":"leo","age":20}' 27 | stringifyJSON(123); /// '123' 28 | stringifyJSON(true); /// 'true' 29 | stringifyJSON(null); /// 'null' 30 | stringifyJSON(() => {}); /// '' 31 | stringifyJSON(Symbol('test')); /// '' 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/sub.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / sub 6 | 7 | # Function: sub() 8 | 9 | > **sub**(`sub1`, `sub2`): `number` 10 | 11 | 减法函数 12 | 13 | ## Parameters 14 | 15 | • **sub1**: `string` \| `number` 16 | 17 | 被减数 18 | 19 | • **sub2**: `string` \| `number` 20 | 21 | 减数 22 | 23 | ## Returns 24 | 25 | `number` 26 | 27 | ## Example 28 | 29 | ```ts 30 | sub(1, 2); /// -1 31 | sub(0.55, 0.1); /// 0.45 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/textCamelCase.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / textCamelCase 6 | 7 | # Function: textCamelCase() 8 | 9 | > **textCamelCase**(`str`): `string` 10 | 11 | 字符串转驼峰 12 | 13 | ## Parameters 14 | 15 | • **str**: `string` 16 | 17 | 字符串 18 | 19 | ## Returns 20 | 21 | `string` 22 | 23 | ## Example 24 | 25 | ```ts 26 | textCamelCase('foo-bar'); /// 'fooBar' 27 | textCamelCase('foo_bar'); /// 'fooBar' 28 | textCamelCase('foo bar'); /// 'fooBar' 29 | textCamelCase('foo.bar'); /// 'fooBar' 30 | ``` 31 | -------------------------------------------------------------------------------- /docs/functions/textSplitCase.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / textSplitCase 6 | 7 | # Function: textSplitCase() 8 | 9 | > **textSplitCase**(`str`): `string`[] 10 | 11 | 按照普遍的特殊字符分割字符串 12 | 13 | ## Parameters 14 | 15 | • **str**: `string` 16 | 17 | 字符串 18 | 19 | ## Returns 20 | 21 | `string`[] 22 | 23 | ## Example 24 | 25 | ```ts 26 | textSplitCase('foo-bar'); /// ['foo', 'bar'] 27 | textSplitCase('foo_bar'); /// ['foo', 'bar'] 28 | textSplitCase('foo bar'); /// ['foo', 'bar'] 29 | textSplitCase('foo.bar'); /// ['foo', 'bar'] 30 | textSplitCase('fooBar'); /// ['foo', 'bar'] 31 | textSplitCase('foo-Bar'); /// ['foo', 'bar'] 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/textTransferCase.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / textTransferCase 6 | 7 | # Function: textTransferCase() 8 | 9 | > **textTransferCase**(`str`, `type`): `string` 10 | 11 | 改变字符串大小写 12 | 13 | ## Parameters 14 | 15 | • **str**: `string` 16 | 17 | 字符串 18 | 19 | • **type**: `1` \| `2` \| `3` \| `"upper"` \| `"lower"` \| `"first"` 20 | 21 | 目标类型 22 | 23 | ## Returns 24 | 25 | `string` 26 | 27 | ## Example 28 | 29 | ```ts 30 | textTransferCase('red', 'upper'|1); /// 'RED' 31 | textTransferCase('red', 'lower'|2); /// 'red' 32 | textTransferCase('red', 'first'|3); /// 'Red' 33 | ``` 34 | -------------------------------------------------------------------------------- /docs/functions/throttle.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / throttle 6 | 7 | # Function: throttle() 8 | 9 | > **throttle**(`fn`, `delay`): () => `void` 10 | 11 | 节流函数-第一次有效（游戏开枪间隔） 12 | 13 | ## Parameters 14 | 15 | • **fn**: `any` 16 | 17 | 执行的函数 18 | 19 | • **delay**: `number` = `2000` 20 | 21 | 延迟时间 22 | 23 | ## Returns 24 | 25 | `Function` 26 | 27 | ### Returns 28 | 29 | `void` 30 | 31 | ## Example 32 | 33 | ```ts 34 | throttle(() => {}, 1000); /// 节流执行 35 | ``` 36 | -------------------------------------------------------------------------------- /docs/functions/timeSince.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / timeSince 6 | 7 | # Function: timeSince() 8 | 9 | > **timeSince**(`date`?, `longAgo`?, `formatter`?): `any` 10 | 11 | 人性化时间 12 | 13 | ## Parameters 14 | 15 | • **date?**: `string` \| `Date` 16 | 17 | 时间/string 18 | 19 | • **longAgo?**: `boolean` = `false` 20 | 21 | 是否显示周月甚至更久 22 | 23 | • **formatter?**: `string` = `'yyyy-mm-dd hh:ii:ss'` 24 | 25 | 正常显示时的时间显示格式 26 | 27 | ## Returns 28 | 29 | `any` 30 | 31 | ## Example 32 | 33 | ```ts 34 | timeSince(new Date()); /// '刚刚' 35 | ``` 36 | -------------------------------------------------------------------------------- /docs/functions/times.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / times 6 | 7 | # Function: times() 8 | 9 | > **times**(`mul1`, `mul2`): `number` 10 | 11 | 乘法函数 12 | 13 | ## Parameters 14 | 15 | • **mul1**: `string` \| `number` 16 | 17 | 被乘数 18 | 19 | • **mul2**: `string` \| `number` 20 | 21 | 乘数 22 | 23 | ## Returns 24 | 25 | `number` 26 | 27 | ## Example 28 | 29 | ```ts 30 | times(1, 2); /// 2 31 | times(0.55, 100); /// 55 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/to.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / to 6 | 7 | # Function: to() 8 | 9 | > **to**(`promise`, `res`?, `rej`?): `Promise`\<`any`\> 10 | 11 | 参考了 to.js，扩展 Promise 用来直接帮助执行且处理异常。 12 | promise 报错不会阻断后面的 Promise，适用于多个 await Promise 情况。 13 | 14 | ## Parameters 15 | 16 | • **promise**: `Promise`\<`any`\> 17 | 18 | promise 19 | 20 | • **res?**: `any` 21 | 22 | 成功回调 23 | 24 | • **rej?**: `any` 25 | 26 | 失败回调 27 | 28 | ## Returns 29 | 30 | `Promise`\<`any`\> 31 | 32 | ## Example 33 | 34 | ```ts 35 | to(Promise.resolve(1)); /// Promise.resolve(1) 36 | // 也可挂载在 Promise 原型上 37 | ``` 38 | -------------------------------------------------------------------------------- /docs/functions/toBool.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / toBool 6 | 7 | # Function: toBool() 8 | 9 | > **toBool**(`value`, `falseList`): `boolean` 10 | 11 | 任意值转换为布尔类型 12 | 13 | ## Parameters 14 | 15 | • **value**: `any` 16 | 17 | 值 18 | 19 | • **falseList**: `any`[] = `[]` 20 | 21 | 判断为 false 的值列表 22 | 23 | ## Returns 24 | 25 | `boolean` 26 | 27 | ## Example 28 | 29 | ```ts 30 | toBool(0); /// true 31 | toBool(''); /// true 32 | toBool('', [0, '']); /// false 33 | toBool(0, [0, '']); /// false 34 | toBool('0'); /// true 35 | toBool(1); /// true 36 | toBool('false'); /// false 37 | toBool('null'); /// false 38 | toBool('undefined'); /// false 39 | toBool('NaN'); /// false 40 | toBool(null); /// false 41 | ``` 42 | -------------------------------------------------------------------------------- /docs/functions/toFormData.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / toFormData 6 | 7 | # Function: toFormData() 8 | 9 | > **toFormData**(`obj`, `hasBrackets`, `hasIndex`): `FormData` 10 | 11 | 对象转 FormData 格式 12 | 13 | ## Parameters 14 | 15 | • **obj**: `any` 16 | 17 | 源数据 18 | 19 | • **hasBrackets**: `boolean` = `false` 20 | 21 | 是否带括号 22 | 23 | • **hasIndex**: `boolean` = `false` 24 | 25 | 是否带 index 26 | 27 | ## Returns 28 | 29 | `FormData` 30 | 31 | ## Example 32 | 33 | ```ts 34 | toFormData({a: 1, b: 2}); /// FormData 35 | ``` 36 | -------------------------------------------------------------------------------- /docs/functions/toNum.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / toNum 6 | 7 | # Function: toNum() 8 | 9 | > **toNum**(`value`): `number` 10 | 11 | 任意值转换为数字 12 | 13 | ## Parameters 14 | 15 | • **value**: `any` 16 | 17 | 值 18 | 19 | ## Returns 20 | 21 | `number` 22 | 23 | ## Example 24 | 25 | ```ts 26 | toNum({}); /// 0 27 | toNum([2]); /// 2 28 | toNum('-123'); /// -123 29 | ``` 30 | -------------------------------------------------------------------------------- /docs/functions/toQueryString.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / toQueryString 6 | 7 | # Function: toQueryString() 8 | 9 | > **toQueryString**(`obj`, `hasBrackets`, `hasIndex`): `URLSearchParams` 10 | 11 | 对象转 URLSearchParams 字符串 12 | 13 | ## Parameters 14 | 15 | • **obj**: `any` 16 | 17 | 源数据 18 | 19 | • **hasBrackets**: `boolean` = `false` 20 | 21 | 是否带括号 22 | 23 | • **hasIndex**: `boolean` = `false` 24 | 25 | 是否带 index 26 | 27 | ## Returns 28 | 29 | `URLSearchParams` 30 | 31 | ## Example 32 | 33 | ```ts 34 | toQueryString({a: 1, b: 2, c: [1, 2]}); /// a=1&b=2&c=1&c=2 35 | toQueryString({a: 1, b: 2, c: [1, 2]}, true); /// a=1&b=2&c[]=1&c[]=2 36 | toQueryString({a: 1, b: 2, c: [1, 2]}, true, true); /// a=1&b=2&c[0]=1&c[1]=2 37 | ``` 38 | -------------------------------------------------------------------------------- /docs/functions/toStr.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / toStr 6 | 7 | # Function: toStr() 8 | 9 | > **toStr**(`value`): `string` 10 | 11 | 任意值转换为字符串 12 | 13 | ## Parameters 14 | 15 | • **value**: `any` 16 | 17 | 值 18 | 19 | ## Returns 20 | 21 | `string` 22 | 23 | ## Example 24 | 25 | ```ts 26 | toStr({}); /// '{}' 27 | toStr([1, 2]); /// '[1,2]' 28 | toStr(null); /// '' 29 | ``` 30 | -------------------------------------------------------------------------------- /docs/functions/toggleClass.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / toggleClass 6 | 7 | # Function: toggleClass() 8 | 9 | > **toggleClass**(`element`, `className`): `void` 10 | 11 | 给元素添加/删除类 12 | 13 | ## Parameters 14 | 15 | • **element**: `any` 16 | 17 | 元素 18 | 19 | • **className**: `string` \| `string`[] 20 | 21 | 类 22 | 23 | ## Returns 24 | 25 | `void` 26 | 27 | ## Example 28 | 29 | ```ts 30 | toggleClass(myElement, 'active'); /// 给元素添加/删除 active 类 31 | toggleClass(myElement, ['active', 'disabled']); /// 给元素添加/删除 active/disabled 类 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/transferCSVData.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / transferCSVData 6 | 7 | # Function: transferCSVData() 8 | 9 | > **transferCSVData**(`fields`, `data`): `string` 10 | 11 | 转换 data 为可导出的 csv 数据 12 | 13 | ## Parameters 14 | 15 | • **fields**: `object`[] 16 | 17 | 导出的栏位 18 | 19 | • **data**: `any`[] 20 | 21 | 数据 22 | 23 | ## Returns 24 | 25 | `string` 26 | 27 | ## Example 28 | 29 | ```ts 30 | transferCSVData([{ prop: 'name' }, { prop: 'age' }], [{ name: '张三', age: 15 }]); /// 可以导出的字符数据 31 | transferCSVData([{ label: '姓名', prop: 'name' }, { label: '年龄', prop: 'age' }], [{ name: '张三', age: 15 }]); /// 可以导出的字符数据 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/transferFileToBase64.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / transferFileToBase64 6 | 7 | # Function: transferFileToBase64() 8 | 9 | > **transferFileToBase64**(`content`, `contentType`, `callBack`): `void` 10 | 11 | 文件流或内容转 Base64 12 | 13 | ## Parameters 14 | 15 | • **content**: `any` 16 | 17 | BlobPart | any 内容 18 | 19 | • **contentType**: `string` 20 | 21 | 内容类型 22 | 23 | • **callBack**: `any` 24 | 25 | 回调函数 26 | 27 | ## Returns 28 | 29 | `void` 30 | 31 | ## Example 32 | 33 | ```ts 34 | transferFileToBase64(file, 'application/pdf;charset=utf-8', (res) => console.log({ res })); /// result object 35 | transferFileToBase64('test', 'text/plain', (res) => console.log({ res })); /// result object 36 | ``` 37 | -------------------------------------------------------------------------------- /docs/functions/transferMoney.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / transferMoney 6 | 7 | # Function: transferMoney() 8 | 9 | > **transferMoney**(`n`): `string` 10 | 11 | 金额转中文 12 | 13 | ## Parameters 14 | 15 | • **n**: `number` 16 | 17 | 数值 18 | 19 | ## Returns 20 | 21 | `string` 22 | 23 | ## Example 24 | 25 | ```ts 26 | transferMoney(900); /// '玖佰元整' 27 | transferMoney(852.5); /// '捌佰伍拾贰元伍角' 28 | ``` 29 | -------------------------------------------------------------------------------- /docs/functions/transferNumber.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / transferNumber 6 | 7 | # Function: transferNumber() 8 | 9 | > **transferNumber**(`number`, `from`, `to`): `string` \| `number` 10 | 11 | 提供进制转换，最大为 64 进制。 12 | 13 | ## Parameters 14 | 15 | • **number**: `number` 16 | 17 | 数值 18 | 19 | • **from**: `number` = `10` 20 | 21 | 原进制 22 | 23 | • **to**: `number` = `2` 24 | 25 | 目标进制 26 | 27 | ## Returns 28 | 29 | `string` \| `number` 30 | 31 | ## Example 32 | 33 | ```ts 34 | transferNumber(100); /// '1100100' 35 | transferNumber(1100100, 2, 10); /// 100 36 | ``` 37 | -------------------------------------------------------------------------------- /docs/functions/transferScanStr.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / transferScanStr 6 | 7 | # Function: transferScanStr() 8 | 9 | > **transferScanStr**(`value`, `higherReplace`): `string` 10 | 11 | 强制转换扫描字符串的特殊字符 12 | `/(=)|(<)|(>)|(《)|(》)|(&)|(%)|(\^)|(!)|(~)|(#)|(@)|(:)|(\s)|(')|(")|(‘)|(’)|(“)|(”)/g` 13 | 14 | ## Parameters 15 | 16 | • **value**: `string` 17 | 18 | 值 19 | 20 | • **higherReplace**: `boolean` = `false` 21 | 22 | 严格替换 23 | 24 | ## Returns 25 | 26 | `string` 27 | 28 | ## Example 29 | 30 | ```ts 31 | transferScanStr('=900182201234500'); /// '900182201234500' 32 | transferScanStr('= **transferSeconds**(`duration`, `returnObj`): `string` \| `any` 10 | 11 | 转换音视频时长，把秒数转换为 hh:ii:ss 格式。 12 | 13 | ## Parameters 14 | 15 | • **duration**: `number` 16 | 17 | 时间/秒 18 | 19 | • **returnObj**: `boolean` = `false` 20 | 21 | 是否返回对象 22 | 23 | ## Returns 24 | 25 | `string` \| `any` 26 | 27 | ## Example 28 | 29 | ```ts 30 | transferSeconds(1234); /// '00:20:34' 31 | transferSeconds(1234, true); /// {h: '00', i: 20, s: 34} 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/transferTemperature.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / transferTemperature 6 | 7 | # Function: transferTemperature() 8 | 9 | > **transferTemperature**(`temperature`, `isCelsius`, `addSuffix`): `string` \| `number` 10 | 11 | 华氏/摄氏度互转 12 | 13 | ## Parameters 14 | 15 | • **temperature**: `string` \| `number` 16 | 17 | • **isCelsius**: `boolean` = `true` 18 | 19 | • **addSuffix**: `boolean` = `true` 20 | 21 | ## Returns 22 | 23 | `string` \| `number` 24 | 25 | ## Example 26 | 27 | ```ts 28 | transferTemperature(30.5); /// '86.9 °F' 29 | transferTemperature(86, false, false); /// 30 30 | ``` 31 | -------------------------------------------------------------------------------- /docs/functions/transferTreeData.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / transferTreeData 6 | 7 | # Function: transferTreeData() 8 | 9 | > **transferTreeData**(`sourceData`, `options`): `any`[] 10 | 11 | 转换数组数据为树状数据 12 | 13 | ## Parameters 14 | 15 | • **sourceData**: `any`[] 16 | 17 | 源数据 18 | 19 | • **options** = `...` 20 | 21 | 转化选项 22 | 23 | • **options.labelKey**: `string` 24 | 25 | • **options.parentKey**: `string` 26 | 27 | • **options.valueKey**: `string` 28 | 29 | ## Returns 30 | 31 | `any`[] 32 | 33 | ## Example 34 | 35 | ```ts 36 | transferTreeData(treeData); /// ... 37 | transferTreeData(treeData, { labelKey: 'title', valueKey: 'key', parentKey: 'parent' }); /// ... 38 | ``` 39 | -------------------------------------------------------------------------------- /docs/functions/trim.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / trim 6 | 7 | # Function: trim() 8 | 9 | > **trim**(`str`, `type`): `string` 10 | 11 | 去除字符串空格 12 | `可选值：0|ba：去除前后空格，1|b：去除前空格，2|a：去除后空格，3|all：去除所有空格，4|pro：去除所有空格，中间的空格保留一个。` 13 | 14 | ## Parameters 15 | 16 | • **str**: `string` 17 | 18 | 字符串 19 | 20 | • **type**: `string` \| `number` = `0` 21 | 22 | 类型，默认为 0|ba，错误 type 会返回原字符串。 23 | 24 | ## Returns 25 | 26 | `string` 27 | 28 | ## Example 29 | 30 | ```ts 31 | trim(' a b ', 4); /// 'a b' 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/truncate.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / truncate 6 | 7 | # Function: truncate() 8 | 9 | > **truncate**(`txt`, `width`, `options`?): `string` 10 | 11 | 截取字符串，使其长度为指定值，包含省略符。 12 | 13 | ## Parameters 14 | 15 | • **txt**: `string` 16 | 17 | 字符串值 18 | 19 | • **width**: `number` 20 | 21 | 指定长度 22 | 23 | • **options?** 24 | 25 | 截取配置 26 | 27 | • **options.ellipsis?**: `string` 28 | 29 | • **options.separator?**: `string` 30 | 31 | ## Returns 32 | 33 | `string` 34 | 35 | ## Example 36 | 37 | ```ts 38 | truncate('HXB HXB HXB HXB HXB HXB', 12); /// 'HXB HXB H...' 39 | truncate('OQM-OQM-OQM-OQM-OQM-OQM', 10, { ellipsis: '～', separator: '-' }); /// 'OQM-OQM～' 40 | ``` 41 | -------------------------------------------------------------------------------- /docs/functions/unicode2str.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / unicode2str 6 | 7 | # Function: unicode2str() 8 | 9 | > **unicode2str**(`value`): `string` 10 | 11 | 字符转 unicode 12 | 13 | ## Parameters 14 | 15 | • **value**: `string` 16 | 17 | 中文字符串 18 | 19 | ## Returns 20 | 21 | `string` 22 | 23 | ## Example 24 | 25 | ```ts 26 | unicode2str("我是老A"); /// '\\u6211\\u662f\\u8001a' 27 | ``` 28 | -------------------------------------------------------------------------------- /docs/functions/union.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / union 6 | 7 | # Function: union() 8 | 9 | > **union**(`paramA`, `paramB`): `any` 10 | 11 | 获取数组或对象并集 12 | 13 | ## Parameters 14 | 15 | • **paramA**: `any` 16 | 17 | 值 A，若冲突以此值为准。 18 | 19 | • **paramB**: `any` 20 | 21 | 值 B 22 | 23 | ## Returns 24 | 25 | `any` 26 | 27 | ## Example 28 | 29 | ```ts 30 | union([1, 2, 2, 3, 3], [1, 2, 4, 5]); /// [1, 2, 3, 4, 5] 31 | union({a: 1, b: 2}, {a: 1, c: 3, b: 4}); /// {a: 1, c: 3, b: 2} 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/unique.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / unique 6 | 7 | # Function: unique() 8 | 9 | > **unique**(`arr`, `filter`?): `any`[] 10 | 11 | 数组去重 12 | 13 | ## Parameters 14 | 15 | • **arr**: `any`[] 16 | 17 | 数组 18 | 19 | • **filter?**: `any` 20 | 21 | 过滤逻辑 22 | 23 | ## Returns 24 | 25 | `any`[] 26 | 27 | ## Example 28 | 29 | ```ts 30 | unique([1, 2, 3, 1, 2, 3]); /// [1, 2, 3] 31 | unique([{id: 1, value: 'hello'}, {id: 2, value: 'world'}, {id: 2, value: 'world', others: true}], (a, b) => a.id === b.id); /// [id1, id2 带 true] 32 | ``` 33 | -------------------------------------------------------------------------------- /docs/functions/useStateData.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / useStateData 6 | 7 | # Function: useStateData() 8 | 9 | > **useStateData**(`initialData`): (`value`) => `any`[] 10 | 11 | 创建用于处理数据的钩子函数 12 | 13 | ## Parameters 14 | 15 | • **initialData**: `any` 16 | 17 | 初始数据 18 | 19 | ## Returns 20 | 21 | (`value`) => `any`[] 22 | 23 | ## Example 24 | 25 | ```ts 26 | const [getData, setData, resetData] = useStateData({a: 1, b: 2, c: 3}); 27 | console.log(getData()); /// {a: 1, b: 2, c: 3} 28 | setData({ a : 10 }); /// {a: 10} 29 | resetData(); /// {a: 1, b: 2, c: 3} 30 | const [getData, setData, resetData] = useStateData('test'); 31 | console.log(getData()); /// 'test' 32 | setData('test001'); /// 'test001' 33 | resetData(); /// 'test' 34 | ``` 35 | -------------------------------------------------------------------------------- /docs/functions/uuid.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / uuid 6 | 7 | # Function: uuid() 8 | 9 | > **uuid**(): `string` 10 | 11 | 获取 V4 版本 UUID 12 | 13 | ## Returns 14 | 15 | `string` 16 | 17 | ## Example 18 | 19 | ```ts 20 | uuid(); /// '7b72e264-61fe-426e-b95f-35d4e61c5742' 21 | ``` 22 | -------------------------------------------------------------------------------- /docs/functions/versionUpgrade.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / versionUpgrade 6 | 7 | # Function: versionUpgrade() 8 | 9 | > **versionUpgrade**(`version`, `maxVersionCode`): `string` 10 | 11 | 版本号升级算法 12 | 13 | ## Parameters 14 | 15 | • **version**: `string` 16 | 17 | 版本号 18 | 19 | • **maxVersionCode**: `number` = `99` 20 | 21 | 最大版本号 22 | 23 | ## Returns 24 | 25 | `string` 26 | 27 | ## Example 28 | 29 | ```ts 30 | versionUpgrade('0.0.1'); /// '0.0.2' 31 | versionUpgrade('0.0.0.9'); /// '0.0.0.10' 32 | versionUpgrade('0.0.0.9', 9); /// '0.0.1.0' 33 | versionUpgrade('0.0.9.9', 9); /// '0.1.0.0' 34 | ``` 35 | -------------------------------------------------------------------------------- /docs/functions/waitUntil.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / waitUntil 6 | 7 | # Function: waitUntil() 8 | 9 | > **waitUntil**(`condition`, `timeout`, `interval`): `Promise`\<`any`\> 10 | 11 | 直到某个函数返回 toBool(true) 的结果(执行完成) 12 | 13 | ## Parameters 14 | 15 | • **condition**: `any` 16 | 17 | 函数 18 | 19 | • **timeout**: `number` = `0` 20 | 21 | 超时 22 | 23 | • **interval**: `number` = `250` 24 | 25 | 执行间隔 26 | 27 | ## Returns 28 | 29 | `Promise`\<`any`\> 30 | 31 | ## Example 32 | 33 | ```ts 34 | let a = 5; 35 | setTimeout(() => (a = 10), 5000); 36 | waitUntil(() => a === 10).then(() => { console.log(a) }); 37 | ``` 38 | -------------------------------------------------------------------------------- /docs/interfaces/CustomKeys.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / CustomKeys 6 | 7 | # Interface: CustomKeys 8 | 9 | CustomKeys 10 | 11 | ## Indexable 12 | 13 | \[`key`: `string`\]: `string` 14 | -------------------------------------------------------------------------------- /docs/interfaces/i18nLanguageResource.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / i18nLanguageResource 6 | 7 | # Interface: i18nLanguageResource 8 | 9 | 语言资源接口选项 10 | 11 | ## Properties 12 | 13 | ### desc 14 | 15 | > **desc**: `string` 16 | 17 | *** 18 | 19 | ### key 20 | 21 | > **key**: `string` 22 | 23 | *** 24 | 25 | ### translation 26 | 27 | > **translation**: `any` 28 | -------------------------------------------------------------------------------- /docs/interfaces/i18nOptions.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / i18nOptions 6 | 7 | # Interface: i18nOptions 8 | 9 | i18n 类的选项 10 | 11 | ## Properties 12 | 13 | ### defaultLang? 14 | 15 | > `optional` **defaultLang**: `string` 16 | 17 | *** 18 | 19 | ### resources 20 | 21 | > **resources**: `Record`\<`string`, [`i18nLanguageResource`](i18nLanguageResource.md)\> 22 | -------------------------------------------------------------------------------- /docs/type-aliases/CryptoOptions.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / CryptoOptions 6 | 7 | # Type Alias: CryptoOptions 8 | 9 | > **CryptoOptions**: *typeof* `CryptoJS` 10 | 11 | CryptoOptions 12 | -------------------------------------------------------------------------------- /docs/type-aliases/CustomAny.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / CustomAny 6 | 7 | # Type Alias: CustomAny 8 | 9 | > **CustomAny**: `any` 10 | 11 | CustomAny 12 | -------------------------------------------------------------------------------- /docs/type-aliases/FileType.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / FileType 6 | 7 | # Type Alias: FileType 8 | 9 | > **FileType**: keyof *typeof* [`CONTENT_TYPES`](../variables/CONTENT_TYPES.md) 10 | 11 | FileType 12 | -------------------------------------------------------------------------------- /docs/type-aliases/MockDataType.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / MockDataType 6 | 7 | # Type Alias: MockDataType 8 | 9 | > **MockDataType**: `"string"` \| `"number"` \| `"boolean"` \| `"date"` \| `"array"` \| `"object"` \| `"null"` \| `"undefined"` 10 | 11 | Mock 数据类型 12 | -------------------------------------------------------------------------------- /docs/variables/ANIMALS.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / ANIMALS 6 | 7 | # Variable: ANIMALS 8 | 9 | > `const` **ANIMALS**: `string`[] 10 | -------------------------------------------------------------------------------- /docs/variables/BASE_CHAR_LOW.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / BASE\_CHAR\_LOW 6 | 7 | # Variable: BASE\_CHAR\_LOW 8 | 9 | > `const` **BASE\_CHAR\_LOW**: `"abcdefghijklmnopqrstuvwxyz"` = `'abcdefghijklmnopqrstuvwxyz'` 10 | -------------------------------------------------------------------------------- /docs/variables/BASE_CHAR_UP.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / BASE\_CHAR\_UP 6 | 7 | # Variable: BASE\_CHAR\_UP 8 | 9 | > `const` **BASE\_CHAR\_UP**: `"ABCDEFGHIJKLMNOPQRSTUVWXYZ"` = `'ABCDEFGHIJKLMNOPQRSTUVWXYZ'` 10 | -------------------------------------------------------------------------------- /docs/variables/BASE_NUMBER.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / BASE\_NUMBER 6 | 7 | # Variable: BASE\_NUMBER 8 | 9 | > `const` **BASE\_NUMBER**: `"0123456789"` = `'0123456789'` 10 | -------------------------------------------------------------------------------- /docs/variables/BLOOD_GROUP.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / BLOOD\_GROUP 6 | 7 | # Variable: BLOOD\_GROUP 8 | 9 | > `const` **BLOOD\_GROUP**: `object` 10 | 11 | ## Type declaration 12 | 13 | ### A 14 | 15 | > **A**: `string` = `'A 型'` 16 | 17 | ### AB 18 | 19 | > **AB**: `string` = `'AB 型'` 20 | 21 | ### B 22 | 23 | > **B**: `string` = `'B 型'` 24 | 25 | ### O 26 | 27 | > **O**: `string` = `'O 型'` 28 | -------------------------------------------------------------------------------- /docs/variables/BLOOD_GROUP_INFO.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / BLOOD\_GROUP\_INFO 6 | 7 | # Variable: BLOOD\_GROUP\_INFO 8 | 9 | > `const` **BLOOD\_GROUP\_INFO**: `object` 10 | 11 | ## Index Signature 12 | 13 | \[`key`: `string`\]: `object` 14 | -------------------------------------------------------------------------------- /docs/variables/CODE_MSG.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / CODE\_MSG 6 | 7 | # Variable: CODE\_MSG 8 | 9 | > `const` **CODE\_MSG**: `object` 10 | 11 | ## Index Signature 12 | 13 | \[`status`: `number`\]: `string` 14 | -------------------------------------------------------------------------------- /docs/variables/CONSTELLATION.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / CONSTELLATION 6 | 7 | # Variable: CONSTELLATION 8 | 9 | > `const` **CONSTELLATION**: `any` 10 | -------------------------------------------------------------------------------- /docs/variables/ICONS.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / ICONS 6 | 7 | # Variable: ICONS 8 | 9 | > `const` **ICONS**: `any` 10 | -------------------------------------------------------------------------------- /docs/variables/ID_CARD_PROVINCE.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / ID\_CARD\_PROVINCE 6 | 7 | # Variable: ID\_CARD\_PROVINCE 8 | 9 | > `const` **ID\_CARD\_PROVINCE**: `object` 10 | 11 | ## Index Signature 12 | 13 | \[`prop`: `string`\]: `string` 14 | -------------------------------------------------------------------------------- /docs/variables/MAN.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / MAN 6 | 7 | # Variable: MAN 8 | 9 | > `const` **MAN**: `1` = `1` 10 | -------------------------------------------------------------------------------- /docs/variables/MONTHS.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / MONTHS 6 | 7 | # Variable: MONTHS 8 | 9 | > `const` **MONTHS**: `object`[] 10 | -------------------------------------------------------------------------------- /docs/variables/PY_MAPS.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / PY\_MAPS 6 | 7 | # Variable: PY\_MAPS 8 | 9 | > `const` **PY\_MAPS**: `any` 10 | -------------------------------------------------------------------------------- /docs/variables/ROLES.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / ROLES 6 | 7 | # Variable: ROLES 8 | 9 | > `const` **ROLES**: `object` 10 | 11 | ## Type declaration 12 | 13 | ### admin 14 | 15 | > **admin**: `string` = `'超级管理员'` 16 | 17 | ### guest 18 | 19 | > **guest**: `string` = `'访客'` 20 | 21 | ### manager 22 | 23 | > **manager**: `string` = `'管理员'` 24 | 25 | ### user 26 | 27 | > **user**: `string` = `'用户'` 28 | 29 | ### viewer 30 | 31 | > **viewer**: `string` = `'只读用户'` 32 | -------------------------------------------------------------------------------- /docs/variables/TRANSFER_STR.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / TRANSFER\_STR 6 | 7 | # Variable: TRANSFER\_STR 8 | 9 | > `const` **TRANSFER\_STR**: `string` 10 | -------------------------------------------------------------------------------- /docs/variables/WEEKS.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / WEEKS 6 | 7 | # Variable: WEEKS 8 | 9 | > `const` **WEEKS**: `object`[] 10 | -------------------------------------------------------------------------------- /docs/variables/WOMAN.md: -------------------------------------------------------------------------------- 1 | [**js-xxx v2.2.31**](../README.md) • **Docs** 2 | 3 | *** 4 | 5 | [js-xxx v2.2.31](../README.md) / WOMAN 6 | 7 | # Variable: WOMAN 8 | 9 | > `const` **WOMAN**: `0` = `0` 10 | -------------------------------------------------------------------------------- /es/Cookies/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Cookies/index.ts"],"names":[],"mappings":"AASA;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAK1C;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,QAQjE;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,QAOvC;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,SAO3B"} -------------------------------------------------------------------------------- /es/Dev/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Dev/index.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;CAoBxB,CAAC;AAEH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuMtB,CAAC;AAEH,eAAO,MAAM,QAAQ,sBAsCpB,CAAC"} -------------------------------------------------------------------------------- /es/Form/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Form/index.ts"],"names":[],"mappings":"AAUA;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,WAAW,UAAQ,EAAE,QAAQ,UAAQ,GAAG,QAAQ,CAepF;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,GAAG,OA4B7C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,WAAW,UAAQ,EAAE,QAAQ,UAAQ,GAAG,eAAe,CAe9F;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,YAAY,CAAC,WAAW,EAAE,GAAG,YAOnB,GAAG,YAqB5B"} -------------------------------------------------------------------------------- /es/Notify/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Notify/index.ts"],"names":[],"mappings":"AAUA;;;;;;GAMG;AACH,wBAAgB,gBAAgB,IAAI,OAAO,CAwB1C;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,MAAM,EACX,KAAK,CAAC,EAAE,MAAM,EACd,OAAO,CAAC,EACJ;IACE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,CAAC;IAC7B,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IACzB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,aAAa,GAAG,MAAM,CAAC;IAE9B,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,OAAO,CAAC,EAAE,GAAG,CAAC;CACf,GAED,mBAAmB,GACnB,SAAS,GACZ,IAAI,CAgCN"} -------------------------------------------------------------------------------- /es/Number/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Number/index.ts"],"names":[],"mappings":"AASA;;;;;;;;;;;;GAYG;AACH,wBAAgB,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAiDpD;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,OAAO,CAQlE;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,GAAG,EAAE,UAAU,UAAQ,GAAG,OAAO,CAatF;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,SAAI,GAAG,MAAM,CAoBlE;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE;IAAE,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAKpF"} -------------------------------------------------------------------------------- /es/Object/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Object/index.ts"],"names":[],"mappings":"AAWA;;;;;;;;;;;;GAYG;AACH,wBAAgB,IAAI,CAAC,aAAa,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,GAAG,GAAG,CAgB1D;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CActD;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,uBAAgB,GAAG,GAAG,CAqC9D;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,KAAK,CAAC,UAAU,EAAE,GAAG,EAAE,QAAQ,CAAC,EAAE,GAAG,WAqBpD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,GAAG,EAAE,WAyBzC;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE;IAAE,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,GAAG,EAAE,CA+BtG;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,cAAc,QAAS,GAAG,QAAa,MAAM,EAAE,iBAAiB,GAAG,QAQ/E,CAAC"} -------------------------------------------------------------------------------- /es/Toast/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Toast/index.ts"],"names":[],"mappings":"AAaA;;;;GAIG;AACH,oBAAY,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;IACxE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,YAqDM,aAAa,mBAIrC,CAAC;AAEL;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,KAAK,CAAC,EAAE,GAAG,QAUpC;AAED;;;;;;;;GAQG;AACH,wBAAgB,KAAK,CACnB,GAAG,EAAE,MAAM,EACX,IAAI,GAAE,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,SAAqB,GACjF,GAAG,CASL;AAED;;;;;;;GAOG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAMxC"} -------------------------------------------------------------------------------- /es/index.d.ts: -------------------------------------------------------------------------------- 1 | export * from './Dev'; 2 | export * from './Array'; 3 | export * from './Cookies'; 4 | export * from './Crypto'; 5 | export * from './Data'; 6 | export * from './Date'; 7 | export * from './Dom'; 8 | export * from './File'; 9 | export * from './Form'; 10 | export * from './Math'; 11 | export * from './Notify'; 12 | export * from './Number'; 13 | export * from './Object'; 14 | export * from './Others'; 15 | export * from './Promise'; 16 | export * from './Request'; 17 | export * from './Storage'; 18 | export * from './String'; 19 | export * from './Toast'; 20 | export * from './Tools'; 21 | export * from './Types'; 22 | export * from './WebSocket'; 23 | export * from './i18n'; 24 | //# sourceMappingURL=index.d.ts.map -------------------------------------------------------------------------------- /es/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAeA,cAAc,OAAO,CAAC;AAEtB,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,QAAQ,CAAC;AACvB,cAAc,OAAO,CAAC;AACtB,cAAc,QAAQ,CAAC;AACvB,cAAc,QAAQ,CAAC;AACvB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,QAAQ,CAAC"} -------------------------------------------------------------------------------- /html/.nojekyll: -------------------------------------------------------------------------------- 1 | TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. -------------------------------------------------------------------------------- /iife/Cookies/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Cookies/index.ts"],"names":[],"mappings":"AASA;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAK1C;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,QAQjE;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,QAOvC;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,SAO3B"} -------------------------------------------------------------------------------- /iife/Dev/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Dev/index.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;CAoBxB,CAAC;AAEH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuMtB,CAAC;AAEH,eAAO,MAAM,QAAQ,sBAsCpB,CAAC"} -------------------------------------------------------------------------------- /iife/Form/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Form/index.ts"],"names":[],"mappings":"AAUA;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,WAAW,UAAQ,EAAE,QAAQ,UAAQ,GAAG,QAAQ,CAepF;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,GAAG,OA4B7C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,WAAW,UAAQ,EAAE,QAAQ,UAAQ,GAAG,eAAe,CAe9F;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,YAAY,CAAC,WAAW,EAAE,GAAG,YAOnB,GAAG,YAqB5B"} -------------------------------------------------------------------------------- /iife/Notify/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Notify/index.ts"],"names":[],"mappings":"AAUA;;;;;;GAMG;AACH,wBAAgB,gBAAgB,IAAI,OAAO,CAwB1C;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,MAAM,EACX,KAAK,CAAC,EAAE,MAAM,EACd,OAAO,CAAC,EACJ;IACE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,CAAC;IAC7B,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IACzB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,aAAa,GAAG,MAAM,CAAC;IAE9B,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,OAAO,CAAC,EAAE,GAAG,CAAC;CACf,GAED,mBAAmB,GACnB,SAAS,GACZ,IAAI,CAgCN"} -------------------------------------------------------------------------------- /iife/Number/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Number/index.ts"],"names":[],"mappings":"AASA;;;;;;;;;;;;GAYG;AACH,wBAAgB,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAiDpD;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,OAAO,CAQlE;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,GAAG,EAAE,UAAU,UAAQ,GAAG,OAAO,CAatF;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,SAAI,GAAG,MAAM,CAoBlE;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE;IAAE,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAKpF"} -------------------------------------------------------------------------------- /iife/Object/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Object/index.ts"],"names":[],"mappings":"AAWA;;;;;;;;;;;;GAYG;AACH,wBAAgB,IAAI,CAAC,aAAa,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,GAAG,GAAG,CAgB1D;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CActD;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,uBAAgB,GAAG,GAAG,CAqC9D;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,KAAK,CAAC,UAAU,EAAE,GAAG,EAAE,QAAQ,CAAC,EAAE,GAAG,WAqBpD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,GAAG,EAAE,WAyBzC;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE;IAAE,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,GAAG,EAAE,CA+BtG;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,cAAc,QAAS,GAAG,QAAa,MAAM,EAAE,iBAAiB,GAAG,QAQ/E,CAAC"} -------------------------------------------------------------------------------- /iife/Toast/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Toast/index.ts"],"names":[],"mappings":"AAaA;;;;GAIG;AACH,oBAAY,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;IACxE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,YAqDM,aAAa,mBAIrC,CAAC;AAEL;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,KAAK,CAAC,EAAE,GAAG,QAUpC;AAED;;;;;;;;GAQG;AACH,wBAAgB,KAAK,CACnB,GAAG,EAAE,MAAM,EACX,IAAI,GAAE,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,SAAqB,GACjF,GAAG,CASL;AAED;;;;;;;GAOG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAMxC"} -------------------------------------------------------------------------------- /iife/index.d.ts: -------------------------------------------------------------------------------- 1 | export * from './Dev'; 2 | export * from './Array'; 3 | export * from './Cookies'; 4 | export * from './Crypto'; 5 | export * from './Data'; 6 | export * from './Date'; 7 | export * from './Dom'; 8 | export * from './File'; 9 | export * from './Form'; 10 | export * from './Math'; 11 | export * from './Notify'; 12 | export * from './Number'; 13 | export * from './Object'; 14 | export * from './Others'; 15 | export * from './Promise'; 16 | export * from './Request'; 17 | export * from './Storage'; 18 | export * from './String'; 19 | export * from './Toast'; 20 | export * from './Tools'; 21 | export * from './Types'; 22 | export * from './WebSocket'; 23 | export * from './i18n'; 24 | //# sourceMappingURL=index.d.ts.map -------------------------------------------------------------------------------- /iife/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAeA,cAAc,OAAO,CAAC;AAEtB,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,QAAQ,CAAC;AACvB,cAAc,OAAO,CAAC;AACtB,cAAc,QAAQ,CAAC;AACvB,cAAc,QAAQ,CAAC;AACvB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,QAAQ,CAAC"} -------------------------------------------------------------------------------- /lib/Cookies/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Cookies/index.ts"],"names":[],"mappings":"AASA;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAK1C;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,QAQjE;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,QAOvC;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,SAO3B"} -------------------------------------------------------------------------------- /lib/Dev/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Dev/index.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;CAoBxB,CAAC;AAEH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuMtB,CAAC;AAEH,eAAO,MAAM,QAAQ,sBAsCpB,CAAC"} -------------------------------------------------------------------------------- /lib/Form/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Form/index.ts"],"names":[],"mappings":"AAUA;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,WAAW,UAAQ,EAAE,QAAQ,UAAQ,GAAG,QAAQ,CAepF;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,GAAG,OA4B7C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,WAAW,UAAQ,EAAE,QAAQ,UAAQ,GAAG,eAAe,CAe9F;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,YAAY,CAAC,WAAW,EAAE,GAAG,YAOnB,GAAG,YAqB5B"} -------------------------------------------------------------------------------- /lib/Notify/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Notify/index.ts"],"names":[],"mappings":"AAUA;;;;;;GAMG;AACH,wBAAgB,gBAAgB,IAAI,OAAO,CAwB1C;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,MAAM,EACX,KAAK,CAAC,EAAE,MAAM,EACd,OAAO,CAAC,EACJ;IACE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,CAAC;IAC7B,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IACzB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,aAAa,GAAG,MAAM,CAAC;IAE9B,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,OAAO,CAAC,EAAE,GAAG,CAAC;CACf,GAED,mBAAmB,GACnB,SAAS,GACZ,IAAI,CAgCN"} -------------------------------------------------------------------------------- /lib/Number/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Number/index.ts"],"names":[],"mappings":"AASA;;;;;;;;;;;;GAYG;AACH,wBAAgB,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAiDpD;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,OAAO,CAQlE;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,GAAG,EAAE,UAAU,UAAQ,GAAG,OAAO,CAatF;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,SAAI,GAAG,MAAM,CAoBlE;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE;IAAE,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAKpF"} -------------------------------------------------------------------------------- /lib/Object/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Object/index.ts"],"names":[],"mappings":"AAWA;;;;;;;;;;;;GAYG;AACH,wBAAgB,IAAI,CAAC,aAAa,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,GAAG,GAAG,CAgB1D;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CActD;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,uBAAgB,GAAG,GAAG,CAqC9D;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,KAAK,CAAC,UAAU,EAAE,GAAG,EAAE,QAAQ,CAAC,EAAE,GAAG,WAqBpD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,GAAG,EAAE,WAyBzC;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE;IAAE,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,GAAG,EAAE,CA+BtG;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,cAAc,QAAS,GAAG,QAAa,MAAM,EAAE,iBAAiB,GAAG,QAQ/E,CAAC"} -------------------------------------------------------------------------------- /lib/Toast/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Toast/index.ts"],"names":[],"mappings":"AAaA;;;;GAIG;AACH,oBAAY,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;IACxE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,YAqDM,aAAa,mBAIrC,CAAC;AAEL;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,KAAK,CAAC,EAAE,GAAG,QAUpC;AAED;;;;;;;;GAQG;AACH,wBAAgB,KAAK,CACnB,GAAG,EAAE,MAAM,EACX,IAAI,GAAE,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,SAAqB,GACjF,GAAG,CASL;AAED;;;;;;;GAOG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAMxC"} -------------------------------------------------------------------------------- /lib/index.d.ts: -------------------------------------------------------------------------------- 1 | export * from './Dev'; 2 | export * from './Array'; 3 | export * from './Cookies'; 4 | export * from './Crypto'; 5 | export * from './Data'; 6 | export * from './Date'; 7 | export * from './Dom'; 8 | export * from './File'; 9 | export * from './Form'; 10 | export * from './Math'; 11 | export * from './Notify'; 12 | export * from './Number'; 13 | export * from './Object'; 14 | export * from './Others'; 15 | export * from './Promise'; 16 | export * from './Request'; 17 | export * from './Storage'; 18 | export * from './String'; 19 | export * from './Toast'; 20 | export * from './Tools'; 21 | export * from './Types'; 22 | export * from './WebSocket'; 23 | export * from './i18n'; 24 | //# sourceMappingURL=index.d.ts.map -------------------------------------------------------------------------------- /lib/index.d.ts.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAeA,cAAc,OAAO,CAAC;AAEtB,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,QAAQ,CAAC;AACvB,cAAc,OAAO,CAAC;AACtB,cAAc,QAAQ,CAAC;AACvB,cAAc,QAAQ,CAAC;AACvB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,QAAQ,CAAC"} -------------------------------------------------------------------------------- /src/Dev/此目录禁止手动修改: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/pandaoh/js-xxx/5f3e7f0c888582d2cee11d61f4ed04494fe14ec5/src/Dev/此目录禁止手动修改 -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "include": ["src/**/*.ts"], 3 | "exclude": ["node_modules", "es", "lib", "dist", "docs", "iife"], 4 | "compilerOptions": { 5 | "target": "es5", 6 | "lib": ["ES2015", "ESNext", "dom", "es5", "es6"], 7 | "module": "ES2015", 8 | "moduleResolution": "node", 9 | "baseUrl": "./", 10 | "paths": { "@/*": ["src/*"] }, 11 | "declaration": true, 12 | "declarationMap": true, 13 | "sourceMap": true, 14 | "outDir": "./tsc", 15 | "removeComments": false, 16 | "noEmit": true, 17 | "downlevelIteration": true, 18 | "declarationDir": "./types", 19 | "esModuleInterop": true, 20 | "forceConsistentCasingInFileNames": true, 21 | "strict": true, 22 | "skipLibCheck": true 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /typedoc.json: -------------------------------------------------------------------------------- 1 | { 2 | // https://typedoc.org/guides/overview/ 3 | "entryPoints": ["src/index.ts"], 4 | "out": "html", 5 | "customCss": "./_docs.custom.css", 6 | "readme": "none", 7 | "includeVersion": true, 8 | // "hostedBaseUrl": "http://x.biugle.cn/", 9 | // "useHostedBaseUrlForAbsoluteLinks": true, 10 | // "skipErrorChecking": true, 11 | "searchInComments": true, 12 | "searchInDocuments": true, 13 | "cleanOutputDir": true, 14 | "disableSources": true 15 | } 16 | --------------------------------------------------------------------------------