# sxran-tool-js

**Repository Path**: sxran-im/sxran-tool-js

## Basic Information

- **Project Name**: sxran-tool-js
- **Description**: javascript工具类库适配器，一套API适配多端写法的工具类库。
如： js和uniapp和微信小程序的相同功能，但是api却不同，这对于我来封装js-sdk维护是有一定的成本。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-11-17
- **Last Updated**: 2025-01-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# `sxran-tool-sdk`

> javascript工具类库适配器，一套API适配多端写法的工具类库。 
> 
> 如： js和uniapp和微信小程序的相同功能，但是api却不同，这对于我来封装js-sdk维护是有一定的成本。


## 编码规范说明
- 如果存在一个ts文件多个接口，应该也必须有一个default。 如 [WebSockets.ts](packages%2Fsxran-tool-interface%2Flib%2FWebSockets.ts)  实现类也是同理。
- 日志的编写规范 常见：`XeString.ts`

## 兼容性规范
- 如果存在app级别公用内容，和实例级别。 【必须】采用实例api为编码


## 安装
只需要再根目录安装就行
```bash
npm i
```

## 生成文档
> 接口文档在doc/index.html中
- 仅仅生成接口的文档就行。
- 如果有新接口，有添加方法，修改接口。
- 命令执行，生成文档。
```bash
# 进入interface目录
cd packages/sxran-tool-interface/
# 
npm run docs
```
- 浏览器查看在根目录的doc/index.html的文件就行。

## 发布
在项目根目录下运行npx lerna run build --stream，这将使用lerna构建所有子项目并将输出发送到控制台。

等待构建完成。完成后，你可以在每个子项目的dist文件夹中找到生成的JavaScript文件。

```bash
npx lerna run build --stream
```
将在本项目的 packages\sxran 生成所有的子集项目。

## 使用

### 其他项目引用

- copy依赖:将上面的拷贝到其他的js项目根目录下。

- 添加依赖:在package.json中添加一下内容。
```json
{
  "dependencies": {
    "sxran-tool-core" : "./sxran/sxran-core",
    "sxran-tool-interface" : "./sxran/sxran-interface",
    "sxran-tool-sdk" : "./sxran/sxran-sdk",
    "sxran-tool-uniapp" : "./sxran/sxran-uniapp",
    "xe-utils": "^3.5.14"
  }
}
```

- 安装
```bash
npm i
```

- main.js初始化
```javascript
import SDK from 'sxran-tool-sdk/Index'
import XeBase from 'sxran-tool-core/XeBase';
const sdk = new SDK();
sdk.setApi(SDK.BASE_NAME,new XeBase());
Vue.prototype.$sxran = sdk;
```