Skip to content

Commit

Permalink
docs: Améliorer le README.
Browse files Browse the repository at this point in the history
  • Loading branch information
regseb committed May 18, 2023
1 parent 3ed2f5d commit 2622712
Showing 1 changed file with 20 additions and 5 deletions.
25 changes: 20 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,32 +52,39 @@ import Cron from "https://deno.land/x/cronnor/mod.js";
### Navigateurs

Elle est aussi accessible directement avec le CDN [jsDelivr][link-jsdelivr] (ou
[UNPKG](https://unpkg.com/cronnor/), [esm.sh](https://esm.sh/cronnor)) :
[UNPKG](https://unpkg.com/browse/cronnor/), [esm.sh](https://esm.sh/cronnor)) :

```JavaScript
import Cron from "https://cdn.jsdelivr.net/npm/cronnor@2/+esm";
import Cron from "https://cdn.jsdelivr.net/npm/cronnor@2";
// import Cron from "https://unpkg.com/cronnor@2";
// import Cron from "https://esm.sh/cronnor@2";
```

## API

- [`new Cron(cronex, func, [options])`](#new-croncronex-func-options)
- [Cron](#cron)
- [`new Cron(cronex, func, [options])`](#new-croncronex-func-options)
- [`Cron.active`](#cronactive)
- [`Cron.run()`](#cronrun)
- [`Cron.start()`](#cronstart)
- [`Cron.stop()`](#cronstop)
- [`Cron.test([date])`](#crontestdate)
- [`Cron.next([start])`](#cronnextstart)
- [`new CronExp(pattern)`](#new-cronexppattern)
- [CronExp](#cronexp)
- [`new CronExp(pattern)`](#new-cronexppattern)
- [`CronExp.test([date])`](#cronexptestdate)
- [`CronExp.next([start])`](#cronexpnextstart)
- [`new At(date, func, [options])`](#new-atdate-func-options)
- [At](#at)
- [`new At(date, func, [options])`](#new-atdate-func-options)
- [`At.run()`](#atrun)
- [`At.abort()`](#atabort)

### Cron

```JavaScript
import Cron from "cronnor/cron";
```

#### `new Cron(cronex, func, [options])`

Crée une tâche _cronée_.
Expand Down Expand Up @@ -146,6 +153,10 @@ Calcule la prochaine date respectant une des expressions _cron_ de la tâche.

### CronExp

```JavaScript
import CronExp from "cronnor/cronexp";
```

#### `new CronExp(pattern)`

Crée une expression _cron_.
Expand Down Expand Up @@ -177,6 +188,10 @@ Calcule la prochaine date respectant l'expression.

### At

```JavaScript
import At from "cronnor/at";
```

#### `new At(date, func, [options])`

Crée une tâche planifiée.
Expand Down

0 comments on commit 2622712

Please sign in to comment.