crontimex/dist/index.d.ts

None-dependencies Cron Time Expression Generator/Builder written in Typescript

import EveryTime from "./EveryTime.js";
/**
 * Cron Time Object
 */
export declare const CronTimex: {
    /**
     * Every nth Time
     * @return {EveryTime}
     * @param interval
     */
    every(interval: number): EveryTime;
    /**
     * Every Minute
     */
    everyMinute(): string;
    /**
     * Every Hour
     */
    everyHour(): string;
    /**
     * Every Hour At
     * @param {number|number[]} minutesOfTheHour - Minutes of the hour.
     * @returns {string}
     */
    everyHourAt(minutesOfTheHour: number | number[]): string;
    /**
     * Every Day
     */
    everyDay(): string;
    /**
     * Every Day At
     * @param {number|number[]} hoursOfTheDay - Hours of the day
     * @param {number|number[]} minutesOfTheHour - Minutes of the Hour
     */
    everyDayAt(hoursOfTheDay: number | number[], minutesOfTheHour?: number | number[]): string;
    /**
     * Every Sunday At
     * @param {number|number[]} hoursOfTheDay - Hours Of the Day
     * @param {number|number[]} minutesOfTheHour - Minutes of the hour.
     */
    everySundayAt(hoursOfTheDay: number | number[], minutesOfTheHour?: number | number[]): string;
    /**
     * Every Sunday
     */
    everySunday(): string;
    /**
     * Every Monday At
     * @param {number|number[]} hoursOfTheDay - Hours Of the Day
     * @param {number|number[]} minutesOfTheHour - Minutes of the hour.
     */
    everyMondayAt(hoursOfTheDay: number | number[], minutesOfTheHour?: number | number[]): string;
    /**
     * Every Monday
     */
    everyMonday(): string;
    /**
     * Every Tuesday At
     * @param {number|number[]} hoursOfTheDay - Hours Of the Day
     * @param {number|number[]} minutesOfTheHour - Minutes of the hour.
     */
    everyTuesdayAt(hoursOfTheDay: number | number[], minutesOfTheHour?: number | number[]): string;
    /**
     * Every Tuesday
     */
    everyTuesday(): string;
    /**
     * Every Wednesday At
     * @param {number|number[]} hoursOfTheDay - Hours Of the Day
     * @param {number|number[]} minutesOfTheHour - Minutes of the hour.
     */
    everyWednesdayAt(hoursOfTheDay: number | number[], minutesOfTheHour?: number | number[]): string;
    /**
     * Every Wednesday
     */
    everyWednesday(): string;
    /**
     * Every Thursday At
     * @param {number|number[]} hoursOfTheDay - Hours Of the Day
     * @param {number|number[]} minutesOfTheHour - Minutes of the hour.
     */
    everyThursdayAt(hoursOfTheDay: number | number[], minutesOfTheHour?: number | number[]): string;
    /**
     * Every Thursday
     */
    everyThursday(): string;
    /**
     * Every Friday At
     * @param {number|number[]} hoursOfTheDay - Hours Of the Day
     * @param {number|number[]} minutesOfTheHour - Minutes of the hour.
     */
    everyFridayAt(hoursOfTheDay: number | number[], minutesOfTheHour?: number | number[]): string;
    /**
     * Every Friday
     */
    everyFriday(): string;
    /**
     * Every Saturday At
     * @param {number|number[]} hoursOfTheDay - Hours Of the Day
     * @param {number|number[]} minutesOfTheHour - Minutes of the hour.
     */
    everySaturdayAt(hoursOfTheDay: number | number[], minutesOfTheHour?: number | number[]): string;
    /**
     * Every Saturday
     */
    everySaturday(): string;
    /**
     * On Specific Days
     * @param {(string|number)[]} days
     */
    onSpecificDays(days: (string | number)[]): string;
    /**
     * On Specific Days At
     * @param {(string|number)[]} days
     * @param {number|number[]} hoursOfTheDay - Hours of the Day
     * @param {number|number[]} minutesOfTheHour - Minutes of the hour
     */
    onSpecificDaysAt(days: (string | number)[], hoursOfTheDay: number | number[], minutesOfTheHour?: number | number[]): string;
    /**
     * Every Week
     */
    everyWeek(): string;
    /**
     * Every Week At
     * @param {number|number[]|string|string[]} daysOfTheWeek - Days of the week
     * @param {number|number[]} hoursOfTheDay - Hours of the day.
     * @param {number|number[]} minutesOfTheHour - Minutes of the hour
     */
    everyWeekAt(daysOfTheWeek: number | string | number[] | string[], hoursOfTheDay?: number | number[], minutesOfTheHour?: number | number[]): string;
    /**
     * Every WeekDay
     * @param {number|string} startDay - Starting day (Monday=1, Sunday=0)
     * @param {number|string} endDay - Starting day (Monday=1, Sunday=0)
     * @returns {string}
     *
     * @example
     * CronTime.everyWeekDay()
     *  // Monday to Friday
     * CronTime.everyWeekDay('sunday', 'thursday')
     *  // Sunday to Thursday
     */
    everyWeekDay(startDay?: string | number, endDay?: string | number): string;
    /**
     * Every WeekDay At
     * @param {number|number[]} hoursOfTheDay - Hours of the day
     * @param {number|number[]} minutesOfTheHour - Minutes of the hour
     * @param {number|string} startDay - Starting day
     * @param {number|string} endDay - Ending day
     * @returns {string}
     */
    everyWeekDayAt(hoursOfTheDay: number | number[], minutesOfTheHour?: number | number[], startDay?: string | number, endDay?: string | number): string;
    /**
     * Every Weekend
     * @param {number|string} startDay - Starting day (Monday=1, Sunday=0)
     * @param {number|string} endDay - Starting day (Monday=1, Sunday=0)
     * @returns {string}
     *
     * @example
     * CronTime.everyWeekend()
     *  // Saturday and Sunday
     * CronTime.everyWeekend('friday', 'saturday')
     *  // Friday and Saturday
     */
    everyWeekend(startDay?: string | number, endDay?: string | number): string;
    /**
     * Every Weekend At
     * @param {number|number[]} hoursOfTheDay - Hours of the day
     * @param {number|number[]} minutesOfTheHour - Minutes of the hour
     * @param {number|string} startDay - Starting day
     * @param {number|string} endDay - Ending day
     * @returns {string}
     */
    everyWeekendAt(hoursOfTheDay: number | number[], minutesOfTheHour?: number | number[], startDay?: string | number, endDay?: string | number): string;
    /**
     * Every Month
     */
    everyMonth(): string;
    /**
     * Every Month on
     * @param {number|number[]} daysOfTheMonth - Days of the month
     * @param {number|number[]} hoursOfTheDay - Hours of the day
     * @param {number|number[]} minutesOfTheHour - Minutes of the hour
     */
    everyMonthOn(daysOfTheMonth: number | number[], hoursOfTheDay?: number | number[], minutesOfTheHour?: number | number[]): string;
    /**
     * Every Year
     */
    everyYear(): string;
    /**
     * Every Year In
     * @param {number|number[]} monthsOfTheYear  - Months of the year
     * @param daysOfTheMonth - Days of the month
     * @param hoursOfTheDay - Hours of the day
     * @param minutesOfTheHour - Minutes of the hour.
     */
    everyYearIn(monthsOfTheYear: number | number[], daysOfTheMonth?: number | number[], hoursOfTheDay?: number | number[], minutesOfTheHour?: number | number[]): string;
    /**
     * Between Time Frames
     * @param {number} start - Start
     * @param {number} end - End
     */
    between(start: number, end: number): EveryTime;
};
export default CronTimex;