Tianyi Cui
72688a3888
cordis 4.0.0-rc.6, plugin-loader, -include, -group, -timer, -hmr, -logger-console, cosmokit 1.8.1, schemastery 3.18.0 — copied from the cordis-workspace checkout, flattened under vendor/, original npm names, private: true. vendor/README.md is the manifest: upstream repos + commit SHAs, local-modification log, sync procedure. Local modification: hmr's locale YAML imports and .i18n() call removed (avoids a runtime YAML import hook we don't vendor).
37 lines
1.1 KiB
Markdown
37 lines
1.1 KiB
Markdown
# @cordisjs/plugin-timer
|
|
|
|
Disposal-aware timer service for Cordis.
|
|
|
|
## Usage
|
|
|
|
```ts
|
|
import { Context } from 'cordis'
|
|
import Timer from '@cordisjs/plugin-timer'
|
|
|
|
const root = new Context()
|
|
await root.plugin(Timer)
|
|
|
|
const dispose = root.timeout(() => {
|
|
root.logger.info('done')
|
|
}, 1000)
|
|
|
|
dispose()
|
|
```
|
|
|
|
Timer handles are registered on the current fiber, so they are cleared
|
|
automatically when the plugin that created them is disposed.
|
|
|
|
## API
|
|
|
|
| API | Description |
|
|
| --- | --- |
|
|
| `ctx.timeout(callback, delay)` | Run once and return a disposer. |
|
|
| `ctx.timeout(delay)` | Return a promise that resolves after `delay`. |
|
|
| `ctx.interval(callback, delay)` | Run repeatedly and return a disposer. |
|
|
| `ctx.interval(delay)` | Return an async iterator that yields on each interval. |
|
|
| `ctx.throttle(callback, delay, noTrailing?)` | Return a throttled function with `.dispose()`. |
|
|
| `ctx.debounce(callback, delay)` | Return a debounced function with `.dispose()`. |
|
|
|
|
`ctx.setTimeout()` and `ctx.setInterval()` are kept as deprecated aliases for
|
|
`ctx.timeout()` and `ctx.interval()`.
|