# nodeTool

**Repository Path**: yichengxian/nodeTool

## Basic Information

- **Project Name**: nodeTool
- **Description**: 摸鱼时候写的的nodeJS工具集合
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://yichengxian.github.io/nodeTool-doc/index.html
- **GVP Project**: No

## Statistics

- **Stars**: 6
- **Forks**: 1
- **Created**: 2020-09-26
- **Last Updated**: 2024-08-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# nodeTool

[github](https://github.com/yichengxian/nodeTool)  [gitee](https://gitee.com/yichengxian/nodeTool)

nodejs常用或常见工具类集合体，由于npm已经存在nodeTool的包，所以发布以y-node-tool包名命名

## 介绍

使用nodejs作为服务端开发时候一些经验总结
~~均采用原生js手撸(996当中摸鱼)~~

比如，我们在判断一个字符串是否为空值的时候

- 我们需要判断字符是是否未定义undefined

- 是否是null值

- 是否是空字符串等

  ```javascript
  let str=null;
  if(undefined === str || null === str || '' === str){
  	console.log('str is empty !');
  }
  ```

当我们使用封装的方法后,这些操作将会变得简单

```javascript
const {StringUtil} = require('y-node-tool');

let str = null ;
if(StringUtil.isEmpty(str)){
   console.log('str is empty !');
}
```



## 工具类实现列表

- StringUtil 字符串工具
- MapUtil] map工具
- BufferUtil buffer工具
- DateUtil 日期工具
- UUID UUID 
- Snowflake 推特雪花算法
- ObjectUtil 对象工具
- ArrayUtil array工具
- PageUtil] 分页工具
- RandomUtil 随机工具
- PhoneUtil 手机号工具
- RandomWeightUtil 随机权重工具
- BufferUtil buffer工具
- NetUtil 网络工具
- IPV4Util ipv4工具
- OSUtil] 系统操作工具(~~好像并不需要怎么封装呀~~)
- ReUtil 正则工具(~~莫名发现好像js的正不是全匹配的不知道是不是姿势不太对~~)
- StringFormatUtil 字符串格式化工具 (~~就是感觉没有就写一个~~)
- ErrorUtil 错误工具
- Base64 base64
- UUIDUtil uuid工具类



## API文档 
 一些方法的实现列表，使用jsdoc生成

[Github Pages](https://yichengxian.github.io/nodeTool-doc/index.html)

## 如何使用
当然这里提供两种方案 ：

-  查看源码并且cv(~~cv大法，哈哈哈,没什么值得的~~)

- 获取已经向npm发布的版本 ：

  ```shell
  npm install y-node-tool
  ```

  ```javascript
  const {StringUtil} = require('y-node-tool');
  ```
- 好的,开始使用吧

## 用例

所有用例在源码 test 目录下可以找到



## 其他