open-index/open-npm huggingface dataset:
npm package: @sumor/utils
Description: 轻呈云Node.JS工具库
Latest version: 17.2.0
Deprecated: SUNSET

# @sumor/utils
轻呈云Node.JS工具库

## 安装

通过 [npm](https://www.npmjs.com/) 安装:
```sh
$ npm install --save @sumor/utils
```

## 使用说明

ES6方式
```js
//例如要访问的程序路径为level1.level2.level3
import {level1} from '@sumor/utils';

level1.level2.level3('parameter1');
```
Node.js CommonJS方式
```js
//例如要访问的程序路径为level1.level2.level3
const {level1} = require('@sumor/utils');

level1.level2.level3('parameter1');
```

## 接口文档

### axios(parameters)
###### 类型
同步函数
### await cmd(execString, parameter, logCallback) 执行本地命令行代码
###### 类型
异步函数
###### 参数
* `execString` `<String>` __需要执行的命令__ (必填项)
* `parameter` `<Object>` __参数__
* `logCallback` `<Function>` __日志回调__
### deploy.node(parameters)
###### 类型
同步函数
### deploy.ssl(parameters)
###### 类型
同步函数
### file(parameters)
###### 类型
同步函数
### new Logger(namespace, context) 日志记录器
可将日志分类存储到各个渠道，如控制台、文件、远程服务
###### 类型
类
###### 参数
* `namespace` `<String>` __命名空间__ _由大写字母构成，将作为分类名称_
* `context` `<Object>` __上下文交互数据__
### await md5(data) 获取MD5加密编码
###### 类型
异步函数
###### 参数
* `data` `<String>` __需要转换的字符串__ (必填项)
### monitor.cpu(parameters)
###### 类型
同步函数
### monitor.memory(parameters)
###### 类型
同步函数
### npm.install(parameters)
###### 类型
同步函数
### npm.publish(parameters)
###### 类型
同步函数
### await port.consume(port) 消耗指定端口
###### 类型
异步函数
###### 参数
* `port` `<Number>` __端口号__ (必填项)
### await port.isOccupied(port) 检查端口号是否占用
###### 类型
异步函数
###### 参数
* `port` `<Number>` __端口号__ (必填项)
### await port.occupy(port) 预定端口
预定指定端口，或随机分配并预定端口
###### 类型
异步函数
###### 参数
* `port` `<Number>` __端口号__ (必填项)
### await port.release(port) 释放端口
释放端口后将把端口放回随机池
###### 类型
异步函数
###### 参数
* `port` `<Number>` __端口号__ (必填项)
### await qrcode(data) 获取二维码图片
###### 类型
异步函数
###### 参数
* `data` `<String>` __需要转换的字符串数据__ (必填项)
### new SSH(parameters) 远程访问终端
通过SSH远程访问服务器，并执行相关系统操作
###### 类型
类
###### 参数
* `host` `<String>` __服务器地址__ (必填项) _IP或域名等可定位到服务器的地址_
* `port` `<String>` __端口号__
* `username` `<String>` __用户名__ (必填项)
* `password` `<String>` __密码__
### uuid() 获取唯一编号
由32位小写字母加数字构成
###### 类型
同步函数