Class MiliCron

A simple Cron Daemon which supports a resolution of up to 10ms.

Hierarchy

  • MiliCron

Constructors

constructor

Accessors

running

Methods

$clear $off $on $once crontabMatchesDateTime getParsedCronExpression restart start stop crontabMatchesDateTime getParsedCronExpression

Constructors

constructor

  • Creates a new instance of the MiliCron class.

    Parameters

    • Optional autostart: boolean

      Whether to automatically start the cron daemon upon instantiation.

    Returns MiliCron

    • A new instance of the MiliCron class.

Accessors

running

  • get running(): boolean

  • Returns a boolean indicating whether the cron daemon is currently running.

    Returns boolean

    • A boolean indicating whether the cron daemon is currently running.

Methods

$clear

  • $clear(event?): void

  • Removes all listeners for the specified event or all events if no event is specified.

    Parameters

    • Optional event: string

      The name of the event to remove all listeners from.

    Returns void

    See

    EventEmitter.removeAllListeners

$off

  • $off(event, cb): void

  • Removes a previously registered callback function for the specified event.

    Parameters

    • event: string

      The name of the event to remove the callback function from.

    • cb: EventCallback

      The callback function to remove.

    Returns void

    See

    EventEmitter.off

$on

  • $on(event, cb): void

  • Registers a callback function to be executed every time the specified event is emitted.

    Parameters

    • event: string

      The name of the event to listen for.

    • cb: EventCallback

      The callback function to execute when the event is emitted.

    Returns void

    See

    EventEmitter.on

$once

  • $once(event, cb): void

  • Registers a callback function to be executed only once when the specified event is emitted.

    Parameters

    • event: string

      The name of the event to listen for.

    • cb: EventCallback

      The callback function to execute when the event is emitted.

    Returns void

    See

    EventEmitter.once

crontabMatchesDateTime

  • Determines whether the given crontab expression matches the given date and time.

    Parameters

    • crontab: string

      The crontab expression to check.

    • now: DateTime

      The date and time to check against the crontab expression.

    Returns boolean

    • A boolean indicating whether the crontab expression matches the given date and time.

getParsedCronExpression

  • Parses the given cron expression and returns either a DateTime object representing the next time the cron expression will match, or a CronTabObject containing the parsed cron expression.

    Parameters

    • cronExpression: string

      The cron expression to parse.

    • Optional now: DateTime

      The current date and time to use as a reference when calculating the next match time. If not provided, the current date and time will be used.

    Returns CronTabObject | DateTime

    • A DateTime object representing the next time the cron expression will match, or a CronTabObject containing the parsed cron expression.

    Throws

    • Throws an error if the cron expression is so invalid that it cannot be recognized, or if the now parameter is not a valid DateTime object.

restart

  • Stops the cron daemon if it is running and then starts it again.

    Returns void

    Function

start

  • Starts the cron daemon if it is not already running.

    Returns void

    Function

stop

  • Stops the cron daemon if it is running.

    Returns void

    Function

Static crontabMatchesDateTime

  • Check if the crontab expression matches the current time

    Parameters

    • crontab: string

      A crontab expression, crontab alias or unix timestamp

    • now: DateTime

      A DateTime object representing the current time

    Returns boolean

    If the crontab expression matches the current time

Static getParsedCronExpression

  • Parses the given cron expression and returns either a DateTime object representing the next time the cron expression will match, or a CronTabObject containing the parsed cron expression.

    Parameters

    • cronExpression: string

      The cron expression to parse.

    • Optional now: DateTime

      The current date and time to use as a reference when calculating the next match time. If not provided, the current date and time will be used.

    Returns CronTabObject | DateTime

    • A DateTime object representing the next time the cron expression will match, or a CronTabObject containing the parsed cron expression.

    Throws

    • Throws an error if the cron expression is so invalid that it cannot be recognized, or if the now parameter is not a valid DateTime object.

Settings

Member Visibility

Theme

On This Page