## Quickstart
====================

[![NPM version][npm-v-2]][npm-url] 
[![NPM Install Size][size]][size-url] 
[![NPM Downloads][download]][download-url]
[![NPM License][license]][license-url]

### API Introduction...
======================================


**1. Install**

```shell
npm install os-sdk
```

**2. Import package**

```javascript
const {sys,mouse} = require('os-sdk');
```

**3. API:sys**

```javascript
// 用于执行系统命令的核心 API
sys.exec(command[, options], callback);
//command：要执行的系统命令（字符串）
// options（可选）：配置项，常用的有：
    // cwd：指定命令执行的工作目录（默认当前目录）。
    // encoding：输出编码（默认 utf8）。
    // timeout：命令超时时间（毫秒，默认 0 无超时）。
// callback：回调函数，接收三个参数：
    // error：命令执行失败（如退出码非 0）时的错误对象。
    // stdout：命令的标准输出（字符串 / Buffer）。
    // stderr：命令的错误输出（字符串 / Buffer）。	
```

```javascript
// 关机
sys.shutdown((err)=>{
	console.log(err);
})
// 重启
sys.reboot((err)=>{
	console.log(err);
})
// 休眠
sys.sleep((err)=>{
	console.log(err);
})
// 锁屏
sys.lockScreen((err)=>{
	console.log(err);
})
```

**3. API:mouse**

```javascript
// 模拟鼠标操作事件
mouse.get();                //光标位置
mouse.move(200,300);        //光标移动;
mouse.scroll(0, 100);       //鼠标滚轮
mouse.click(2);             // 0=左键 1=右键 2中间键
mouse.start((xy)=>{
	// 开始监听鼠标移动
	console.log(xy); //{ x: 200, y: 300 }
})
mouse.stop() // 结束监听鼠标移动
```


[npm-v-1]: https://badgen.net/npm/v/os-sdk
[npm-v-2]: https://img.shields.io/npm/v/os-sdk
[npm-url]: https://www.npmjs.com/package/os-sdk
[size]: https://badgen.net/packagephobia/install/os-sdk
[size-url]: https://packagephobia.com/result?p=os-sdk
[download]: https://badgen.net/npm/dt/os-sdk
[download-url]: https://npmcharts.com/compare/os-sdk?minimal=true
[license]:https://badgen.net/npm/license/os-sdk
[license-url]:https://npmmirror.com/package/os-sdk/files/LICENSE