lts-cron-editor
Version:
基于antd、react的crontab表达式生成工具
115 lines (84 loc) • 4.14 kB
Markdown
## cron-editor-react
cron表达式生成工具
## Installation
```shell
npm i @tulaoda/cron-editor-react --save
```
## Usage
```javascript
import CronEditor from '@tulaoda/cron-editor-react';
const handleCronChange = (cronExpression) => {
console.log(cronExpression) //0 0 0 * * ?
}
<CronEditor
onChange={handleCronChange}
tabType="card"
showCrontab={false}
value={'0 0 0 * * ?'}
/>
```
## API
| Prop | Description | Default |
| --------------------- | ---------------------------------------------------------------- | ----------- |
| value | crontab表达式传值 | 0 0 0 * * ? |
| onChange | 值改变触发 | noop |
| showRunTime（待优化） | 本地计算并展示最近五次的运行时间（未全面测试api，谨慎使用，通常由后端计算返回，也更合理，可作为备选方案。） | false |
| tabType | antd tab 页签的基本样式，可选 line、card editable-card 类型 | 'line' |
| showCrontab | 是否显示crontab表达式input，目前通过input修改禁用 | true |
## Keywords
cron、react、js
## 更新日志
### 5.0.0 (2020-04-03)
- 修复星期表达式从星期一为1的问题
### 2.0.0 (2019-11-28)
- 新增 API:tabType、showCrontab
### 1.0.9 (2019-11-21)
#### 业务需求修改
> 日：
- 不指定：‘日’不指定和‘周’不指定，有且仅有一个不指定
- 第一个值小于等于第二个值
- 周期：几日开始，每几天执行一次
- 本月最后一天，不能填，只能是最后一天
- 具体天数，默认第一天
> 月：
- 不指定：删掉
- 周期：第一个值小于等于第二个值
- 具体月数，默认第一月
> 星期：
- 不指定：‘日’不指定和‘周’不指定，有且仅有一个不指定
- 周期：第一个值小于等于第二个值
- 具体星期数：默认星期一
- 暂时禁用Input修改cron
### 1.0.7 (2019-11-07)
- 暂时禁用Input修改cron
### 1.0.6 (2019-11-07)
- 增加propTypes 校验
- 可选显示客户端计算周期执行时间
- 修改默认值
## License
[MIT](./LICENSE)
# CRON表达式简介
> CRON表达式是一个字符串，包含五个到七个由空格分隔的字段（每种软件不一样），表示一组时间，通常作为执行某个程序的时间表。
例子：每月的最后1天：0 0 L * * *
说明：
```
* * * * * * *
┬ ┬ ┬ ┬ ┬ ┬ ┬
│ │ │ │ │ | └ year (*)
│ │ │ │ │ └ day of week (0 - 7) (0 or 7 is Sun)
│ │ │ │ └───── month (1 - 12)
│ │ │ └────────── day of month (1 - 31)
│ │ └─────────────── hour (0 - 23)
│ └──────────────────── minute (0 - 59)
└───────────────────────── second (0 - 59, optional)
```
| 字段 | 是否必填 | 允许值 | 允许特殊字符 | 备注 |
| ------------ | -------- | --------------- | ------------ | ---------------------- |
| Seconds | 是 | 0–59 | *,- | 标准实现不支持此字段。 |
| Minutes | 是 | 0–59 | *,- |
| Hours | 是 | 0–23 | *,- |
| Day of month | 是 | 1–31 | *,-?LW | ?LW只有部分软件实现了 |
| Month | 是 | 1–12 or JAN–DEC | *,- |
| Day of week | 是 | 0–6 or SUN–SAT | *,-?L# | ?L#只有部分软件实现了 |
| Year | 否 | 1970–2099 | *,- | 标准实现不支持此字段。 |