imccyu 31f4441fd4 pkg: update vendor dep 1 месяц назад
..
src 72688a3888 Vendor Cordis framework packages as source 3 месяцев назад
LICENSE 72688a3888 Vendor Cordis framework packages as source 3 месяцев назад
README.md 72688a3888 Vendor Cordis framework packages as source 3 месяцев назад
package.json 31f4441fd4 pkg: update vendor dep 1 месяц назад
tsconfig.json 7f131dd4d8 refactor: rename build typings dir to types 2 месяцев назад

README.md

@cordisjs/plugin-timer

Disposal-aware timer service for Cordis.

Usage

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().