https://github.com/saqqdy/js-cool

Collection of common JavaScript / TypeScript utilities
https://github.com/saqqdy/js-cool

await-to cache compareversion cookies csv fingerprint get-types js-cool js-functions library localstorage osversion random tool utilties uuid

Last synced: 2 months ago
JSON representation

Collection of common JavaScript / TypeScript utilities

• Host: GitHub
• URL: https://github.com/saqqdy/js-cool
• Owner: saqqdy
• License: mit
• Created: 2021-01-16T15:13:16.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-05-06T07:52:04.000Z (9 months ago)
• Last Synced: 2024-05-06T08:58:12.118Z (9 months ago)
• Topics: await-to, cache, compareversion, cookies, csv, fingerprint, get-types, js-cool, js-functions, library, localstorage, osversion, random, tool, utilties, uuid
• Language: TypeScript
• Homepage: https://www.saqqdy.com/js-cool
• Size: 3.72 MB
• Stars: 16
• Watchers: 2
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README-zh_CN.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        


# js-cool

这是一个 Javascript 常用方法库

[![NPM version][npm-image]][npm-url]

[![Codacy Badge][codacy-image]][codacy-url]

[![tree shaking][tree-shaking-image]][tree-shaking-url]

![typescript][typescript-url]

[![Test coverage][codecov-image]][codecov-url]

[![npm download][download-image]][download-url]

[![gzip][gzip-image]][gzip-url]

[![License][license-image]][license-url]

[![Sonar][sonar-image]][sonar-url]





### **[Documentation](https://www.saqqdy.com/js-cool)** • **[Change Log](./CHANGELOG.md)**

**使用其他语言阅读：[English](./README.md) | 简体中文**



## 安装

```bash

# 使用pnpm安装

pnpm install js-cool

# 使用npm安装

npm install --save js-cool

```

## 使用

### ES6 模块方式引入

```js

import { osVersion } from 'js-cool'

osVersion()

```

### Node.js require

```js

const { osVersion } = require('js-cool')

osVersion()

```

2. 使用 CDN 引入

```html

  jsCool.browserVersion()

```

## 所有方法汇总

```js

const functionList = {

  // 全局参数

  client, // client方法返回一个浏览器判断结果对象

  pattern, // pattern返回一些常用的正则

  // String扩展、数组方法

  trim, // 根据传参来去除空格

  clearAttr, // 去除HTML标签所有属性

  clearHtml, // 去除HTML标签

  escape, // 转义HTML特殊字符

  unescape, // 还原转义HTML特殊字符

  getNumber, // 获取字符串中的数字

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

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

  randomColor, // 生成随机16进制颜色

  randomNumber, // 获取随机整数

  randomNumbers, // 获取总和固定的n个随机整数

  randomString, // 获取随机字符串

  shuffle, // 打乱字符串或数组的顺序

  fingerprint, // 生成浏览器指纹

  getCHSLength, // 获取字符串长度，中文算2个字符

  cutCHSString, // 截取字符串，中文算2个字节

  // 获取一下状态

  isDigitals, // 是否为由数字组成的字符串

  isExitsFunction, // 是否存在指定函数

  isExitsVariable, // 是否存在指定变量

  isEqual, // 比较2个对象是否相等

  isWindow, // 是否window对象

  isPlainObject, // 是否plainObject

  isDarkMode, // 是否暗色模式

  isObject, // 是否object类型

  isDate, // 是否日期类型

  isRegExp, // 是否正则类型

  isArray, // 判断是否数组

  isIterable, // 判断是否可迭代对象

  inBrowser, // 判断是否在浏览器端运行

  inNodeJs, // 判断是否在nodejs环境运行

  isNumberBrowser, // 判断是否360浏览器

  windowSize, // windowSize获取窗口大小

  getAppVersion, // 获取APP版本号(deprecated)

  appVersion, // 获取APP版本号

  getOsVersion, // 获取系统版本(deprecated)

  osVersion, // 获取系统名称和版本

  browserVersion, // 获取浏览器版本

  compareVersion, // 版本号大小对比

  parseUrlParam, // 解析url参数（key1=value1&key2=value2）

  spliceUrlParam, // 拼接URL参数（仅支持单层）

  safeParse, // 安全解析JSON字符串

  safeStringify, // 安全转换JSON对象为字符串

  getDirParam, // 获取目录形式URL参数

  getQueryParam, // 获取query参数（#后面）

  getQueryParams, // 获取所有query参数（#后面）

  getUrlParam, // 获取单个URL参数

  getUrlParams, // 获取所有URL参数

  // 缓存、cookie、session

  getCache, // 读取localStorage

  setCache, // 写入localStorage

  delCache, // 删除localStorage

  getSession, // 读取sessionStorage

  setSession, // 写入sessionStorage

  delSession, // 删除sessionStorage

  getCookie, // 读取cookie

  getCookies, // 读取所有cookie

  setCookie, // 写入cookie

  delCookie, // 删除cookie

  // 编码与解码

  encodeBase64, // 字符串、数字转base64

  encodeUtf8, // 编码Utf8

  decodeBase64, // base64解码

  decodeUtf8, // 解码Utf8

  // 事件委托、其他事件方法

  stopBubble, // 阻止冒泡

  stopDefault, // 阻止默认事件

  addEvent, // 事件委托，支持多次委托

  removeEvent, // removeEvent移除由addEvent创建的事件委托

  getScrollPosition, // 获取滑动到顶部和底部 返回'top' 'bottom'，建议使用限流

  // 工具类

  nextIndex, // 返回下一个zIndex值

  nextVersion, // 返回下一个版本号

  punctualTimer, // 准时的setInterval

  promiseFactory, // 将一个对象转换为promise like api

  fixNumber, // 截取小数点后几位，不足的不补0

  mapTemplate, // 替换模板字符串的特定数据

  extend, // 深拷贝&合并对象

  clone, // 深拷贝 (不支持Buffer、Promise、Set、Map)

  delay, // 防抖节流

  getType, // 获取目标类型

  getFileType, // 根据链接后缀判断文件类型

  sorter, // 排序工厂函数

  sortPinyin, // 中文按拼音排序

  cleanData, // 清洗数据

  download, // 文件下载

  searchObject, // 对象查找

  openUrl, // 新标签页打开链接（浏览器不能解析的文件跳转下载）

  copy, // 复制到剪贴板

  toThousands, // 千分位分割方法

  all, // 如果所提供的谓词函数对一个集合中的所有元素都返回true，则返回true，否则返回false。

  any, // 如果所提供的谓词函数对一个集合中的至少一个元素返回true，则返回true，否则返回false。

  uuid, // 浏览器端生成uuid，采用v4方法

  CSVToArray, // csv与json、array相互转换

  arrayToCSV, // csv与json、array相互转换

  CSVToJSON, // csv与json、array相互转换

  JSONToCSV, // csv与json、array相互转换

  RGBToHex, // 将RGB组件的值转换为颜色代码。

  intersect, // 多个数组求交集

  union, // 求多个数组的并集

  minus, // 求多个数组的差集，属于A但不属于B/C/D...的元素

  complement, // 多个数组求补集

  contains, // 数组是否包含指定元素

  unique, // 数组去重

  fillIPv6, // ipv6地址补全

  getProperty, // 根据路径字符串获取数组、对象属性值

  setProperty, // 根据路径字符串设置数组、对象属性值

  loadSource, // 动态加载资源，支持js、图片、css链接、css样式字符串

  mountCss, // 动态加载css链接资源

  mountImg, // 动态加载图片资源

  mountJs, // 动态加载js链接资源

  mountStyle, // 动态加载css样式

  preloader, // 图片预加载

  waiting, // 等待一段时间

  awaitTo, // 替代try catch处理promise错误

  // 二进制

  arrayBufferToBase64, // arrayBuffer转Base64

  arrayBufferToBlob, // arrayBuffer转Blob

  base64ToArrayBuffer, // base64转ArrayBuffer

  base64ToBlob, // base64转Blob

  base64ToFile, // base64转File

  blobToArrayBuffer, // blob转ArrayBuffer

  blobToBase64, // blob转Base64

  blobToUrl, // blob转Url

  fileToBase64, // file转Base64

  svgToBlob, // svg转Blob

  urlToBlob // url转Blob

}

```

## 问题和支持

请提交一个 issue [here](https://github.com/saqqdy/js-cool/issues).

## License

[MIT](LICENSE)

[npm-image]: https://img.shields.io/npm/v/js-cool.svg?style=flat-square

[npm-url]: https://npmjs.org/package/js-cool

[codacy-image]: https://app.codacy.com/project/badge/Grade/f70d4880e4ad4f40aa970eb9ee9d0696

[codacy-url]: https://www.codacy.com/gh/saqqdy/js-cool/dashboard?utm_source=github.com&utm_medium=referral&utm_content=saqqdy/js-cool&utm_campaign=Badge_Grade

[tree-shaking-image]: https://badgen.net/bundlephobia/tree-shaking/js-cool

[tree-shaking-url]: https://bundlephobia.com/package/js-cool

[typescript-url]: https://badgen.net/badge/icon/typescript?icon=typescript&label

[codecov-image]: https://img.shields.io/codecov/c/github/saqqdy/js-cool.svg?style=flat-square

[codecov-url]: https://codecov.io/github/saqqdy/js-cool?branch=master

[download-image]: https://img.shields.io/npm/dm/js-cool.svg?style=flat-square

[download-url]: https://npmjs.org/package/js-cool

[gzip-image]: http://img.badgesize.io/https://unpkg.com/js-cool/dist/index.global.prod.js?compression=gzip&label=gzip%20size:%20JS

[gzip-url]: http://img.badgesize.io/https://unpkg.com/js-cool/dist/index.global.prod.js?compression=gzip&label=gzip%20size:%20JS

[license-image]: https://img.shields.io/badge/License-MIT-blue.svg

[license-url]: LICENSE

[sonar-image]: https://sonarcloud.io/api/project_badges/quality_gate?project=saqqdy_js-cool

[sonar-url]: https://sonarcloud.io/dashboard?id=saqqdy_js-cool