Class CronClient

constructor

• new CronClient(timeZone?, debug?): CronClient

• Parameters

  • timeZone: string = defTimeZone

  • debug: boolean = false

  Returns CronClient

timeZone

add

• add(options): CronClient

• Parameters

  • options: {
        name: string;
        onStartup?: boolean;
        run: (() => unknown);
        time: string | Date | DateTime<boolean>;
        timeZone?: string;
    }

    • name: string

    • Optional onStartup?: boolean

    • run: (() => unknown)

      • • (): unknown

        • Returns unknown

    • time: string | Date | DateTime<boolean>

    • Optional timeZone?: string

  Returns CronClient

get

• get(name): null | CronJob<null, null>

• Parameters

  • name: string

  Returns null | CronJob<null, null>

list

• list(): {
      job: CronJob<null, null>;
      name: string;
  }[]

• Returns {
      job: CronJob<null, null>;
      name: string;
  }[]

remove

• remove(name): CronClient

• Parameters

  • name: string

  Returns CronClient

removeAll

• removeAll(): boolean

• Returns boolean