seiue-c3-util v1.4.2

@seiue/util

Util collection for React or React Native apps, including util functions, hooks, components and type functions.

Install

yarn add @seiue/util

API

@seiue/util re-export 了 Lodash 的大部分方法, 如果你发现缺少某个你需要的方法, 可在 lodash.ts 中添加.

Lodash 文档: 官方英文, 中文.

Lodash 之外的所有 util 文档由 TypeDoc 自动生成, 请见 http://doc.seiue.com/util

Dev Flow

1. Check out new branch from master.
2. Add more (or update) utils.
3. Add (or update) JSDoc comments.
4. Add (or update) unit tests.
5. Update CHANGELOG.md.
6. Update version with yarn version.
7. Create PR and merge into master.
8. CI publishes new version to Seiue registry.

JSDoc

写 JSDoc 注释时, 需注意以下事项:

1. 每个函数都要用 @category 正确归类.
2. 参数是一个 object 时, 需给出 object 和 object 内各个 key 的注释, 请参考 useSetInterval.
3. React 组件在类型上要写成普通函数的形式方便 TypeDoc 生成文档, 请参考 Lazy 组件.

ESlint

建议在 ESLint 配置中用 no-restricted-imports 规则禁止开发者直接 import lodash 和 query-string, 统一使用 @seiue/util.