open-index/open-npm huggingface dataset:
npm package: @pakwoon/api-generator
Description: CLI is used to generate interface call typescript methods and type declarations based on interface document fields
Latest version: 0.1.3

# @pakwoon/api-generator

服务端API生成工具

* 服务对接
* 生成规则
  * 模版管理
  * 数据格式转换
  * 字符模版拼接
  * 文件引用逻辑
  * 循环引用问题处理
* 异常兼容（同名类，同名api，特殊类型转换）
* 更新规则
* 用户使用
npm package: @pakwoon/base-ui
Description: ## css
Latest version: 1.1.3

# @xmn/base-ui

## css

css-in-js

styled-component

## Get Started

按开发环境的要求，运行和调试项目

运行和调试组件

```
pnpm run dev
```

运行测试用例

```
pnpm run test
```

按照社区规范和最佳实践，生成构建产物

```
pnpm run build
```

继续创建更多项目要素

```
pnpm run new
```

其他

```
pnpm run lint         # 检查和修复所有代码
pnpm run change       # 添加 changeset，用于发版时生成 changelog
pnpm run bump         # 生成发版相关的修改，比如更新版本号、生成 changelog
pnpm run release      # 根据 bump 自动修改和人工修改的发版要求，发布项目

```
npm package: @pakwoon/biz-config
Description: ## Prerequisites
Latest version: 0.0.1

# Your Package

## Prerequisites

1. [Node.js LTS](https://github.com/nodejs/Release)
    * [Automatically call nvm use](https://github.com/nvm-sh/nvm#deeper-shell-integration)

## Get Started

按开发环境的要求，运行和调试项目

运行和调试组件

```
pnpm run dev
```

运行测试用例

```
pnpm run test
```

按照社区规范和最佳实践，生成构建产物

```
pnpm run build
```

继续创建更多项目要素

```
pnpm run new
```

其他

```
pnpm run lint         # 检查和修复所有代码
pnpm run change       # 添加 changeset，用于发版时生成 changelog
pnpm run bump         # 生成发版相关的修改，比如更新版本号、生成 changelog
pnpm run release      # 根据 bump 自动修改和人工修改的发版要求，发布项目

```
npm package: @pakwoon/client-api
Description: api 服务项目模版
Latest version: 1.0.291

# node-service-template

api 服务项目模版

## Get Started

按开发环境的要求，运行和调试项目

```
pnpm dev
```

服务端打包

```
pnpm service_build
```

api 私有库打包

```
pnpm lib_build
```

整体打包

```
pnpm build
```

由于 modern.js 部署问题，现本地打包验证需要使用 modern build -c modern.config.ts 命令进行打包，再通过 modern serve 命令启动。（该过程会将 api 服务的内容输出到 dist 文件，影响 api 库，所以验证完记得删除）
npm package: @pakwoon/common-utils
Description: 通用工具包
Latest version: 2.0.3

# @pakwoon/common-utils

通用工具包

## 日期

### compareTime

比较时间大小

#### 参数

- `time` _(string | number | Date)_ - 待比较时间
- `target` ? _(string | number | Date)_ - 目标时间（默认当前时间）

#### 返回

_(number)_ - 0: 相等，1: 大于，-1: 小于

### getBetweenDate

获取两日期间日期列表

#### 参数

- `dateStr` _(string)_ - 指定日期
- `targetDateStr` ? _(string)_ - 目标日期（默认当天）

#### 返回

_(string[])_ - 两日期间日期字符串列表

### getDateFormat

获取指定日期格式化后的字符串值

#### 参数

- `params` _(Params)_
  - `date` ? _(Date)_ - 日期（默认今天）
  - `formatIndex` ? _(number)_ - 格式化模式（默认：0）
    - 0: YYYY-MM-DD
    - 1: YYYY-MM-DD HH:mm:ss
    - 2: YYYY/MM/DD
    - 3: YYYY/MM/DD HH:mm:ss
    - 4: HH:mm:ss
    - 5: YYYY 年 MM 月 DD 日
    - 6: YYYY 年 MM 月 DD 日 HH 时 mm 分 ss 秒
    - 7: YYYY 年 MM 月 DD 日 HH 时 mm 分 ss 秒
  - `fillZero` ？ _(boolean)_ 是否补零（默认：是）

#### 返回

_(string)_ - 指定日期格式化后的字符串值

## 判断

### isNull

判断是否为 null

#### 入参

- `val` _(any)_ - 任何值

#### 返回

_(boolean)_ - 判断结果

### isUndefined

判断是否为 undefined

#### 入参

- `val` _(any)_ - 任何值

#### 返回

_(boolean)_ - 判断结果

## 对象

### omitNullVal

去除对象中值为空元素的属性（空字符串，null，undefined）

#### 入参

- `obj` _(Record<string, any>)_ - 待处理对象

#### 返回

_(Record<string, any>)_ - 不带空元素属性的对象

## 字符串

### toUppercaseFirstLetter

字符串首字母转大写

#### 入参

- `str` _(string)_ - 待转换字符串

#### 返回

_(string)_ - 转换后字符串

## url

### addQueryString

给指定 url 添加 queryString

#### 入参

- `url` _(string)_ - 原 url
- `query` _(Record<string, any>)_ - 待组装 queryString 对象

#### 返回

_(string)_ - 组装后的完整 url

### getQueryString

获取 queryString 对象或属性

#### 入参

- `url` ? _(string)_ - url（默认当前 url）
- `param` ? _(string)_ - 参数 key

#### 返回

_(undefined | string | SARecord)_ - queryString 对象或属性 或 不存在

### urlSearchParams

获取 queryString 对象或属性（用法与`getQueryString`一致）

## 类型

### ClearRecord

根据范型传入情况去除对象属性类型为 never 的属性

#### 使用

```typescript
type RequestOption<Query = never, Data = never> = ClearRecord<{
  query: Query;
  data: Data;
  headers?: Record<string, string>;
}>;
```

## 业务

### token

#### encryptedToken

加密 token

##### 入参

- `str` ? _(string)_ - 待加密的字符串
- `encryptKey` ? _(string)_ - 密钥

##### 返回

_(string)_ - 加密后的 token

#### decryptedToken

解密 token

##### 入参

- `encrypted` ? _(string)_ - 加密后的 token
- `encryptKey` ? _(string)_ - 密钥

##### 返回

_(string)_ - 加密前 token

#### getAccessToken

在 url 上获取 accessToken

##### 返回

_(string)_ - accessToken

#### setRefreshToken

存储 refreshToken 到 localStorage 中

##### 入参

- `refreshToken` ? _(string)_ - refreshToken

#### getRefreshToken

在 localStorage 中获取 refreshToken

##### 返回

- `refreshToken` ? _(string)_ - refreshToken

#### clearRefreshToken

清除 localStorage 中的 refreshToken

#### setToken

存储 token 到 localStorage 中

##### 入参

- `token` ? _(string)_ - token

#### getToken

在 localStorage 中获取 token

##### 返回

- _(string)_ - token

#### clearToken

清除 localStorage 中的 token

#### tokenConfig

统一设置 encryptKey，并返回完整 token 操作对象

### isLogin

根据 token 判断是否已登录

##### 返回

- _(boolean)_ 是否已登录

### useIntl

umi 多语言 hook

### createModel

umi dva 快速创建 model 方法

## 枚举

### ENV

系统运行环境

* DEV - 开发环境
* TEST - 测试环境
* PRE - 预发布环境
* PROD - 开发环境
npm package: @pakwoon/config-api
Description: api 服务项目模版
Latest version: 1.0.3

# node-service-template

api 服务项目模版

## Get Started

按开发环境的要求，运行和调试项目

```
pnpm dev
```

服务端打包

```
pnpm service_build
```

api 私有库打包

```
pnpm lib_build
```

整体打包

```
pnpm build
```

由于 modern.js 部署问题，现本地打包验证需要使用 modern build -c modern.config.ts 命令进行打包，再通过 modern serve 命令启动。（该过程会将 api 服务的内容输出到 dist 文件，影响 api 库，所以验证完记得删除）
npm package: @pakwoon/eslint-preset
Description: eslint preset
Latest version: 1.1.1

# @pakwoon/eslint-preset

### 介绍

前端工程化预设 - eslint

### 目前包含

- import/order - import 分组排序

### 使用方式

### eslint

安装包

```sh
pnpm add @pakwoon/eslint-preset -D
```

在 .eslintrc.js 中添加配置

```js
module.exports = {
  extends: [require.resolve('@pakwoon/eslint-preset')],
};
```
npm package: @pakwoon/get-config
Description: ## Prerequisites
Latest version: 0.0.1

# Your Package

## Prerequisites

1. [Node.js LTS](https://github.com/nodejs/Release)
    * [Automatically call nvm use](https://github.com/nvm-sh/nvm#deeper-shell-integration)

## Get Started

按开发环境的要求，运行和调试项目

运行和调试组件

```
pnpm run dev
```

运行测试用例

```
pnpm run test
```

按照社区规范和最佳实践，生成构建产物

```
pnpm run build
```

继续创建更多项目要素

```
pnpm run new
```

其他

```
pnpm run lint         # 检查和修复所有代码
pnpm run change       # 添加 changeset，用于发版时生成 changelog
pnpm run bump         # 生成发版相关的修改，比如更新版本号、生成 changelog
pnpm run release      # 根据 bump 自动修改和人工修改的发版要求，发布项目

```
npm package: @pakwoon/gql-type-generator
Description: ## Prerequisites
Latest version: 0.1.1

# Your Package

## Prerequisites

1. [Node.js LTS](https://github.com/nodejs/Release)
    * [Automatically call nvm use](https://github.com/nvm-sh/nvm#deeper-shell-integration)

## Get Started

按开发环境的要求，运行和调试项目

运行和调试组件

```
pnpm run dev
```

运行测试用例

```
pnpm run test
```

按照社区规范和最佳实践，生成构建产物

```
pnpm run build
```

继续创建更多项目要素

```
pnpm run new
```

其他

```
pnpm run lint         # 检查和修复所有代码
pnpm run change       # 添加 changeset，用于发版时生成 changelog
pnpm run bump         # 生成发版相关的修改，比如更新版本号、生成 changelog
pnpm run release      # 根据 bump 自动修改和人工修改的发版要求，发布项目

```
npm package: @pakwoon/graphql-client
Description: ## Prerequisites
Latest version: 0.1.6

# Your Package

## Prerequisites

1. [Node.js LTS](https://github.com/nodejs/Release)
    * [Automatically call nvm use](https://github.com/nvm-sh/nvm#deeper-shell-integration)

## Get Started

按开发环境的要求，运行和调试项目

运行和调试组件

```
pnpm run dev
```

运行测试用例

```
pnpm run test
```

按照社区规范和最佳实践，生成构建产物

```
pnpm run build
```

继续创建更多项目要素

```
pnpm run new
```

其他

```
pnpm run lint         # 检查和修复所有代码
pnpm run change       # 添加 changeset，用于发版时生成 changelog
pnpm run bump         # 生成发版相关的修改，比如更新版本号、生成 changelog
pnpm run release      # 根据 bump 自动修改和人工修改的发版要求，发布项目

```
npm package: @pakwoon/hooks
Description: ## Prerequisites
Latest version: 0.1.1

# Your Package

## Prerequisites

1. [Node.js LTS](https://github.com/nodejs/Release)
    * [Automatically call nvm use](https://github.com/nvm-sh/nvm#deeper-shell-integration)

## Get Started

按开发环境的要求，运行和调试项目

运行和调试组件

```
pnpm run dev
```

运行测试用例

```
pnpm run test
```

按照社区规范和最佳实践，生成构建产物

```
pnpm run build
```

继续创建更多项目要素

```
pnpm run new
```

其他

```
pnpm run lint         # 检查和修复所有代码
pnpm run change       # 添加 changeset，用于发版时生成 changelog
pnpm run bump         # 生成发版相关的修改，比如更新版本号、生成 changelog
pnpm run release      # 根据 bump 自动修改和人工修改的发版要求，发布项目

```
npm package: @pakwoon/monitor-api
Description: api 服务项目模版
Latest version: 1.0.50

# node-service-template

api 服务项目模版

## Get Started

按开发环境的要求，运行和调试项目

```
pnpm dev
```

服务端打包

```
pnpm service_build
```

api 私有库打包

```
pnpm lib_build
```

整体打包

```
pnpm build
```

由于 modern.js 部署问题，现本地打包验证需要使用 modern build -c modern.config.ts 命令进行打包，再通过 modern serve 命令启动。（该过程会将 api 服务的内容输出到 dist 文件，影响 api 库，所以验证完记得删除）
npm package: @pakwoon/stylelint-preset
Description: ## Prerequisites
Latest version: 1.0.1

# Your Package

## Prerequisites

1. [Node.js LTS](https://github.com/nodejs/Release)
    * [Automatically call nvm use](https://github.com/nvm-sh/nvm#deeper-shell-integration)

## Get Started

按开发环境的要求，运行和调试项目

运行和调试组件

```
pnpm run dev
```

运行测试用例

```
pnpm run test
```

按照社区规范和最佳实践，生成构建产物

```
pnpm run build
```

继续创建更多项目要素

```
pnpm run new
```

其他

```
pnpm run lint         # 检查和修复所有代码
pnpm run change       # 添加 changeset，用于发版时生成 changelog
pnpm run bump         # 生成发版相关的修改，比如更新版本号、生成 changelog
pnpm run release      # 根据 bump 自动修改和人工修改的发版要求，发布项目

```
npm package: @pakwoon/umi-plugin-directory
Description: ## Prerequisites
Latest version: 1.0.1

# Your Package

## Prerequisites

1. [Node.js LTS](https://github.com/nodejs/Release)
    * [Automatically call nvm use](https://github.com/nvm-sh/nvm#deeper-shell-integration)

## Get Started

按开发环境的要求，运行和调试项目

运行和调试组件

```
pnpm run dev
```

运行测试用例

```
pnpm run test
```

按照社区规范和最佳实践，生成构建产物

```
pnpm run build
```

继续创建更多项目要素

```
pnpm run new
```

其他

```
pnpm run lint         # 检查和修复所有代码
pnpm run change       # 添加 changeset，用于发版时生成 changelog
pnpm run bump         # 生成发版相关的修改，比如更新版本号、生成 changelog
pnpm run release      # 根据 bump 自动修改和人工修改的发版要求，发布项目

```
npm package: @pakwoon/url
Description: ## Prerequisites
Latest version: 0.1.5

# Your Package

## Prerequisites

1. [Node.js LTS](https://github.com/nodejs/Release)
    * [Automatically call nvm use](https://github.com/nvm-sh/nvm#deeper-shell-integration)

## Get Started

按开发环境的要求，运行和调试项目

运行和调试组件

```
pnpm run dev
```

运行测试用例

```
pnpm run test
```

按照社区规范和最佳实践，生成构建产物

```
pnpm run build
```

继续创建更多项目要素

```
pnpm run new
```

其他

```
pnpm run lint         # 检查和修复所有代码
pnpm run change       # 添加 changeset，用于发版时生成 changelog
pnpm run bump         # 生成发版相关的修改，比如更新版本号、生成 changelog
pnpm run release      # 根据 bump 自动修改和人工修改的发版要求，发布项目

```
npm package: @pakwoon/utils
Description: ## Prerequisites
Latest version: 1.0.1

# Your Package

## Prerequisites

1. [Node.js LTS](https://github.com/nodejs/Release)
    * [Automatically call nvm use](https://github.com/nvm-sh/nvm#deeper-shell-integration)

## Get Started

按开发环境的要求，运行和调试项目

运行和调试组件

```
pnpm run dev
```

运行测试用例

```
pnpm run test
```

按照社区规范和最佳实践，生成构建产物

```
pnpm run build
```

继续创建更多项目要素

```
pnpm run new
```

其他

```
pnpm run lint         # 检查和修复所有代码
pnpm run change       # 添加 changeset，用于发版时生成 changelog
pnpm run bump         # 生成发版相关的修改，比如更新版本号、生成 changelog
pnpm run release      # 根据 bump 自动修改和人工修改的发版要求，发布项目

```