🤖 Merge PR #65724 [@breejs/later] add types by @JamieMagee

This commit is contained in:
Jamie Magee
2023-06-09 13:24:53 -07:00
committed by GitHub
parent ef0def9c0b
commit 28f13f1e19
4 changed files with 828 additions and 0 deletions

View File

@@ -0,0 +1,138 @@
import later = require('@breejs/later');
const now = new Date();
later.second.name; // $ExpectType string
later.second.range; // $ExpectType number
later.second.val(now); // $ExpectType number
later.second.isValid(now, 1); // $ExpectType boolean
later.second.extent(); // $ExpectType number[]
later.second.start(now); // $ExpectType Date
later.second.end(now); // $ExpectType Date
later.second.next(now, 1); // $ExpectType Date
later.second.prev(now, 1); // $ExpectType Date
later.minute.name; // $ExpectType string
later.minute.range; // $ExpectType number
later.minute.val(now); // $ExpectType number
later.minute.isValid(now, 1); // $ExpectType boolean
later.minute.extent(); // $ExpectType number[]
later.minute.start(now); // $ExpectType Date
later.minute.end(now); // $ExpectType Date
later.minute.next(now, 1); // $ExpectType Date
later.minute.prev(now, 1); // $ExpectType Date
later.hour.name; // $ExpectType string
later.hour.range; // $ExpectType number
later.hour.val(now); // $ExpectType number
later.hour.isValid(now, 1); // $ExpectType boolean
later.hour.extent(); // $ExpectType number[]
later.hour.start(now); // $ExpectType Date
later.hour.end(now); // $ExpectType Date
later.hour.next(now, 1); // $ExpectType Date
later.hour.prev(now, 1); // $ExpectType Date
later.day.name; // $ExpectType string
later.day.range; // $ExpectType number
later.day.val(now); // $ExpectType number
later.day.isValid(now, 1); // $ExpectType boolean
later.day.extent(); // $ExpectType number[]
later.day.start(now); // $ExpectType Date
later.day.end(now); // $ExpectType Date
later.day.next(now, 1); // $ExpectType Date
later.day.prev(now, 1); // $ExpectType Date
later.dayOfWeek.name; // $ExpectType string
later.dayOfWeek.range; // $ExpectType number
later.dayOfWeek.val(now); // $ExpectType number
later.dayOfWeek.isValid(now, 1); // $ExpectType boolean
later.dayOfWeek.extent(); // $ExpectType number[]
later.dayOfWeek.start(now); // $ExpectType Date
later.dayOfWeek.end(now); // $ExpectType Date
later.dayOfWeek.next(now, 1); // $ExpectType Date
later.dayOfWeek.prev(now, 1); // $ExpectType Date
later.dayOfWeekCount.name; // $ExpectType string
later.dayOfWeekCount.range; // $ExpectType number
later.dayOfWeekCount.val(now); // $ExpectType number
later.dayOfWeekCount.isValid(now, 1); // $ExpectType boolean
later.dayOfWeekCount.extent(); // $ExpectType number[]
later.dayOfWeekCount.start(now); // $ExpectType Date
later.dayOfWeekCount.end(now); // $ExpectType Date
later.dayOfWeekCount.next(now, 1); // $ExpectType Date
later.dayOfWeekCount.prev(now, 1); // $ExpectType Date
later.dayOfYear.name; // $ExpectType string
later.dayOfYear.range; // $ExpectType number
later.dayOfYear.val(now); // $ExpectType number
later.dayOfYear.isValid(now, 1); // $ExpectType boolean
later.dayOfYear.extent(); // $ExpectType number[]
later.dayOfYear.start(now); // $ExpectType Date
later.dayOfYear.end(now); // $ExpectType Date
later.dayOfYear.next(now, 1); // $ExpectType Date
later.dayOfYear.prev(now, 1); // $ExpectType Date
later.weekOfMonth.name; // $ExpectType string
later.weekOfMonth.range; // $ExpectType number
later.weekOfMonth.val(now); // $ExpectType number
later.weekOfMonth.isValid(now, 1); // $ExpectType boolean
later.weekOfMonth.extent(); // $ExpectType number[]
later.weekOfMonth.start(now); // $ExpectType Date
later.weekOfMonth.end(now); // $ExpectType Date
later.weekOfMonth.next(now, 1); // $ExpectType Date
later.weekOfMonth.prev(now, 1); // $ExpectType Date
later.weekOfMonth.name; // $ExpectType string
later.weekOfMonth.range; // $ExpectType number
later.weekOfMonth.val(now); // $ExpectType number
later.weekOfMonth.isValid(now, 1); // $ExpectType boolean
later.weekOfMonth.extent(); // $ExpectType number[]
later.weekOfMonth.start(now); // $ExpectType Date
later.weekOfMonth.end(now); // $ExpectType Date
later.weekOfMonth.next(now, 1); // $ExpectType Date
later.weekOfMonth.prev(now, 1); // $ExpectType Date
later.month.name; // $ExpectType string
later.month.range; // $ExpectType number
later.month.val(now); // $ExpectType number
later.month.isValid(now, 1); // $ExpectType boolean
later.month.extent(); // $ExpectType number[]
later.month.start(now); // $ExpectType Date
later.month.end(now); // $ExpectType Date
later.month.next(now, 1); // $ExpectType Date
later.month.prev(now, 1); // $ExpectType Date
later.year.name; // $ExpectType string
later.year.range; // $ExpectType number
later.year.val(now); // $ExpectType number
later.year.isValid(now, 1); // $ExpectType boolean
later.year.extent(); // $ExpectType number[]
later.year.start(now); // $ExpectType Date
later.year.end(now); // $ExpectType Date
later.year.next(now, 1); // $ExpectType Date
later.year.prev(now, 1); // $ExpectType Date
later.parse.recur().on(1).minute(); // $ExpectType RecurrenceBuilder
later.parse.recur().on(1).hour(); // $ExpectType RecurrenceBuilder
later.parse.recur().on('08:00:00').time(); // $ExpectType RecurrenceBuilder
later.parse.recur().first().minute(); // $ExpectType RecurrenceBuilder
later.parse.recur().on(5).hour().last().dayOfMonth(); // $ExpectType RecurrenceBuilder
later.parse.recur().on(5).minute().onWeekend(); // $ExpectType RecurrenceBuilder
later.parse.recur().on(5).minute().onWeekday(); // $ExpectType RecurrenceBuilder
later.parse.recur().every(10).minute(); // $ExpectType RecurrenceBuilder
later.parse.recur().every(3).month(); // $ExpectType RecurrenceBuilder
later.parse.recur().after(55).minute(); // $ExpectType RecurrenceBuilder
later.parse.recur().every(6).hour().after('09:00').time(); // $ExpectType RecurrenceBuilder
later.parse.recur().before(3).month(); // $ExpectType RecurrenceBuilder
later.parse.recur().every(6).hour().before('09:00').time(); // $ExpectType RecurrenceBuilder
later.parse.recur().after('09:00').time().before('18:00').time(); // $ExpectType RecurrenceBuilder
later.parse.recur().after(9).hour().before(18).hour(); // $ExpectType RecurrenceBuilder
later.parse.recur().every(15).minute().startingOn(10); // $ExpectType RecurrenceBuilder
later.parse.recur().every(2).hour().first().dayOfMonth().and().on(8, 20).hour().last().dayOfMonth(); // $ExpectType RecurrenceBuilder
later.parse.recur().every().minute().except().every(2).minute().between(2, 59).and().every(3).minute().between(3, 59); // $ExpectType RecurrenceBuilder
const schedule = later.parse.text('every 5 min'); // $ExpectType ScheduleData
const timer = later.setTimeout(() => {}, schedule); // $ExpectType Timer
const timer2 = later.setInterval(() => {}, schedule); // $ExpectType Timer
timer.clear(); // $ExpectType void

663
types/breejs__later/index.d.ts vendored Normal file
View File

@@ -0,0 +1,663 @@
// Type definitions for @breejs/later 4.1
// Project: https://github.com/breejs/later
// Definitions by: Jamie Magee <https://github.com/JamieMagee>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
export interface ScheduleData {
/**
* A list of recurrence information as a composite schedule.
*/
schedules: Recurrence[];
/**
* A list of exceptions to the composite recurrence information.
*/
exceptions: Recurrence[];
/**
* A code to identify any errors in the composite schedule and exceptions.
* The number tells you the position of the error within the schedule.
*/
error: number;
}
export interface Recurrence {
/** Time in seconds from midnight. */
t?: number[] | undefined;
/** Seconds in minute. */
s?: number[] | undefined;
/** Minutes in hour. */
m?: number[] | undefined;
/** Hour in day. */
h?: number[] | undefined;
/** Day of the month. */
D?: number[] | undefined;
/** Day in week. */
dw?: number[] | undefined;
/** Nth day of the week in month. */
dc?: number[] | undefined;
/** Day in year. */
dy?: number[] | undefined;
/** Week in month. */
wm?: number[] | undefined;
/** ISO week in year. */
wy?: number[] | undefined;
/** Month in year. */
M?: number[] | undefined;
/** Year. */
Y?: number[] | undefined;
/** After modifiers. */
t_a?: number[] | undefined;
/** After modifiers. */
s_a?: number[] | undefined;
/** After modifiers. */
m_a?: number[] | undefined;
/** After modifiers. */
h_a?: number[] | undefined;
/** After modifiers. */
D_a?: number[] | undefined;
/** After modifiers. */
dw_a?: number[] | undefined;
/** After modifiers. */
dc_a?: number[] | undefined;
/** After modifiers. */
dy_a?: number[] | undefined;
/** After modifiers. */
wm_a?: number[] | undefined;
/** After modifiers. */
wy_a?: number[] | undefined;
/** After modifiers. */
M_a?: number[] | undefined;
/** After modifiers. */
Y_a?: number[] | undefined;
/** Before modifiers. */
t_b?: number[] | undefined;
/** Before modifiers. */
s_b?: number[] | undefined;
/** Before modifiers. */
m_b?: number[] | undefined;
/** Before modifiers. */
h_b?: number[] | undefined;
/** Before modifiers. */
D_b?: number[] | undefined;
/** Before modifiers. */
dw_b?: number[] | undefined;
/** Before modifiers. */
dc_b?: number[] | undefined;
/** Before modifiers. */
dy_b?: number[] | undefined;
/** Before modifiers. */
wm_b?: number[] | undefined;
/** Before modifiers. */
wy_b?: number[] | undefined;
/** Before modifiers. */
M_b?: number[] | undefined;
/** Before modifiers. */
Y_b?: number[] | undefined;
/*
* Custom Time Periods and Modifiers
* For access to custom time periods created as extension to the later static type
* and modifiers created on the later modifier static type.
*/
[timePeriodAndModifierName: string]: number[] | undefined;
}
/**
* Parse
* For generating schedule data.
*/
export namespace parse {
/**
* Create a recurrence builder for building schedule data.
*/
function recur(): RecurrenceBuilder;
/**
* Create schedule data by parsing a cron string
*
* @param input - A string value to parse.
* @param hasSeconds - Whether the cron expression has second part.
*/
function cron(input?: string, hasSeconds?: boolean): ScheduleData;
/**
* Create schedule data by paring a human readable string.
*
* @param input - A string value to parse.
*/
function text(input?: string): ScheduleData;
}
export interface Timer {
/**
* Clear the timer and end execution.
*/
clear(): void;
}
export interface Schedule {
/**
* Finds the next valid instance or instances of the current schedule,
* optionally between a specified start and end date. Start date is
* Date.now() by default, end date is unspecified. Start date must be
* smaller than end date.
*
* @param numberOfInst: The number of instances to return
* @param dateFrom: The earliest a valid instance can occur
* @param dateTo: The latest a valid instance can occur
*/
next(numberOfInst: number, dateFrom?: Date, dateTo?: Date): Date[] | Date;
/**
* Finds the next valid range or ranges of the current schedule,
* optionally between a specified start and end date. Start date is
* Date.now() by default, end date is unspecified. Start date must be
* greater than end date.
*
* @param numberOfInst: The number of ranges to return
* @param dateFrom: The earliest a valid range can occur
* @param dateTo: The latest a valid range can occur
*/
nextRange(numberOfInst: number, dateFrom?: Date, dateTo?: Date): Date[] | Date;
/**
* Finds the previous valid instance or instances of the current schedule,
* optionally between a specified start and end date. Start date is
* Date.now() by default, end date is unspecified. Start date must be
* greater than end date.
*
* @param numberOfInst: The number of instances to return
* @param dateFrom: The earliest a valid instance can occur
* @param dateTo: The latest a valid instance can occur
*/
prev(numberOfInst: number, dateFrom?: Date, dateTo?: Date): Date[] | Date;
/**
* Finds the previous valid range or ranges of the current schedule,
* optionally between a specified start and end date. Start date is
* Date.now() by default, end date is unspecified. Start date must be
* greater than end date.
*
* @param numberOfInst: The number of ranges to return
* @param dateFrom: The earliest a valid range can occur
* @param dateTo: The latest a valid range can occur
*/
prevRange(numberOfInst: number, dateFrom?: Date, dateTo?: Date): Date[] | Date;
}
export interface RecurrenceBuilder extends ScheduleData {
/** a time period */
second(): RecurrenceBuilder;
/** a time period */
minute(): RecurrenceBuilder;
/** a time period */
hour(): RecurrenceBuilder;
/** a time period */
time(): RecurrenceBuilder;
/** a time period */
dayOfWeek(): RecurrenceBuilder;
/** a time period */
dayOfWeekCount(): RecurrenceBuilder;
/** a time period */
dayOfMonth(): RecurrenceBuilder;
/** a time period */
dayOfYear(): RecurrenceBuilder;
/** a time period */
weekOfMonth(): RecurrenceBuilder;
/** a time period */
weekOfYear(): RecurrenceBuilder;
/** a time period */
month(): RecurrenceBuilder;
/** a time period */
year(): RecurrenceBuilder;
/** a time period */
fullDate(): RecurrenceBuilder;
/**
* Specifies one or more specific values of a time period information provider.
* When used to specify a time, a string indicating the 24-hour time may be used.
*
* @param values - A list of values.
*/
on(...values: number[]): RecurrenceBuilder;
/**
* Specifies one or more specific values of a time period information provider.
* When used to specify a time, a string indicating the 24-hour time may be used.
*
* @param value - A Date or string representing your value.
*/
on(value: Date | string): RecurrenceBuilder;
/**
* Precede a time period.
*
* @param value - A number or string representing your value.
*/
every(value?: number | string): RecurrenceBuilder;
/**
* Precede a time period.
*
* @param start - A number representing your start value.
* @param end - A number representing your end value.
*/
between(start: number, end: number): RecurrenceBuilder;
/**
* Precede a time period.
*
* @param start - A string representing your start value.
* @param end - A string representing your end value.
*/
between(start: string, end: string): RecurrenceBuilder;
/**
* After a time period.
*
* @param value - A number or string representing your value.
*/
after(value: number | string): RecurrenceBuilder;
/**
* Before a time period.
*
* @param value - A number or string representing your value.
*/
before(value: number | string): RecurrenceBuilder;
/**
* After a time period.
*
* @param value - A number or string representing your value.
*/
startingOn(value: number | string): RecurrenceBuilder;
/**
* Equivalent to .on(min)
*/
first(): RecurrenceBuilder;
/**
* Equivalent to .on(max)
*/
last(): RecurrenceBuilder;
/**
* Equivalent to .on(1,7).dayOfWeek()
*/
onWeekend(): RecurrenceBuilder;
/**
* Equivalent to .on(2,3,4,5,6).dayOfWeek()
*/
onWeekday(): RecurrenceBuilder;
/**
* Add a new schedule value to schedules, composite schedule.
*/
and(): RecurrenceBuilder;
/**
* Add exceptions.
*/
except(): RecurrenceBuilder;
/**
* Custom Time period Recurrences.
* Using a key as defined by the custom period in any extension to Later.IStatic.
*/
customPeriod(key: string): RecurrenceBuilder;
/**
* Customize Recurrences.
* Using a key as defined by the custom modifier in any extension to Later.IModifierStatic.
*/
customModifier(key: string, values: number): RecurrenceBuilder;
}
/**
* Date Provider
*/
export namespace date {
/**
* Set later to use UTC time.
*/
function UTC(): void;
/**
* Set later to use local time.
*/
function localTime(): void;
/**
* Builds and returns a new Date using the specified values. Date
* returned is either using Local time or UTC based on isLocal.
*
* @param Y: Four digit year
* @param M: Month between 1 and 12, defaults to 1
* @param D: Date between 1 and 31, defaults to 1
* @param h: Hour between 0 and 23, defaults to 0
* @param m: Minute between 0 and 59, defaults to 0
* @param s: Second between 0 and 59, defaults to 0
*/
function next(Y?: number, M?: number, D?: number, h?: number, m?: number, s?: number): Date;
/**
* Builds and returns a new Date using the specified values. Date
* returned is either using Local time or UTC based on isLocal.
*
* @param Y: Four digit year
* @param M: Month between 0 and 11, defaults to 11
* @param D: Date between 1 and 31, defaults to last day of month
* @param h: Hour between 0 and 23, defaults to 23
* @param m: Minute between 0 and 59, defaults to 59
* @param s: Second between 0 and 59, defaults to 59
*/
function prev(Y?: number, M?: number, D?: number, h?: number, m?: number, s?: number): Date;
/**
* Determines if a value will cause a particular constraint to rollover to the
* next largest time period. Used primarily when a constraint has a
* variable extent.
*
* @param d: Date
* @param val: Value
* @param constraint: A modifier
* @param period: A time period
*/
function nextRollover(d: Date, val: number, constraint: Modifier, period: TimePeriod): Date;
/**
* Determines if a value will cause a particular constraint to rollover to the
* previous largest time period. Used primarily when a constraint has a
* variable extent.
*
* @param d: Date
* @param val: Value
* @param constraint: A modifier
* @param period: A time period
*/
function prevRollover(d: Date, val: number, constraint: Modifier, period: TimePeriod): Date;
}
export interface TimePeriod {
/**
* The name of the time period information provider.
*/
name: string;
/**
* The rough number of seconds that are covered when moving from one instance of this time period to the next instance.
*/
range: number;
/**
* The value of this time period for the date specified.
*
* @param date - The given date.
*/
val(date: Date): number;
/**
* True if the specified value is valid for the specified date, false otherwise.
*
* @param date - The given date.
* @param value - The value to test for the date.
*/
isValid(date: Date, value: any): boolean;
/**
* The minimum and maximum valid values for the time period for the specified date.
* If the minimum value is not 0, 0 can be specified in schedules to indicate the maximum value.
* This makes working with non - constant extents(like days in a month) easier.
*
* @param date - The given date.
*/
extent(date?: Date): number[];
/**
* The first second in which the value is the same as the value of the specified date.
* For example, the start of an hour would be the hour with 0 minutes and 0 seconds.
*
* @param date - The given date.
*/
start(date: Date): Date;
/**
* The last second in which the value is the same as the value of the specified date.
* For example, the end of an hour would be the hour with 59 minutes and 59 seconds.
*
* @param date - The given date.
*/
end(date: Date): Date;
/**
* Returns the next date where the value is the value specified.
* Sets the value to 1 if value specified is greater than the max allowed value.
*
* @param date - The given date.
* @param value - The value to test for the date.
*/
next(date: Date, value: any): Date;
/**
* Returns the previous date where the value is the value specified.
* Sets the value to the max allowed value if the value specified is greater than the max allowed value.
*
* @param date - The given date.
* @param value - The value to test for the date.
*/
prev(date: Date, value: any): Date;
}
export interface Modifier extends TimePeriod {
/**
* Creates a new modified constraint.
*
* @param constraint: The constraint to be modified
* @param value: The starting value of the after constraint
*/(constraint: TimePeriod, value: number): TimePeriod;
}
/**
* Later Modifiers:
*
* This type can be easily extended to include any custom IModifiers that you desire.
* These can then be used to create schedules of your own custom type.
*
* interface IGandalfsLaterModifier extends Later.IModifierStatic {
* duringTheThirdAge: IModifier
* }
*
* Be sure to use this interface when dealing with Later.modifier
*/
export namespace modifier {
/**
* After Modifier
*/
const after: Modifier;
/**
* Before Modifier
*/
const before: Modifier;
}
export namespace array {
/**
* Sorts the array in place.
* @param array The array to be sorted
* @param zeroIsLast Should zero be sorted to the end of the array
*/
function sort(array: number[], zeroIsLast?: boolean): void;
/**
* Returns the next valid value in the array.
* @param current The current value
* @param array The array to be searched
* @param extent The extents of the array
*/
function next(current: number, array: number[], extent: [minimum: number, maximum: number]): number;
/**
* Returns the next invalid value in the array.
* @param current The current value
* @param array The array to be searched
* @param extent The extents of the array
*/
function nextInvalid(current: number, array: number[], extent: [minimum: number, maximum: number]): number;
/**
* Returns the previous valid value in the array.
* @param current The current value
* @param array The array to be searched
* @param extent The extents of the array
*/
function prev(current: number, array: number[], extent: [minimum: number, maximum: number]): number;
/**
* Returns the previous invalid value in the array.
* @param current The current value
* @param array The array to be searched
* @param extent The extents of the array
*/
function prevInvalid(current: number, array: number[], extent: [minimum: number, maximum: number]): number;
}
/**
* Generates instances from schedule data.
*/
export function schedule(input: any): Schedule;
/**
* @param schedule The schedule to be parsed
*/
export function compile(schedule: Schedule): TimePeriod;
/**
* Set timeout on window using given recurrence next.
*
* @param callback - A callback called after first instance of recurrence pattern.
* @param time A recurrence instance.
*/
export function setTimeout(callback: () => void, time: ScheduleData): Timer;
/**
* Set interval on window using given recurrence
*
* @param callback - A callback called after each instance of recurrence pattern.
* @param time A recurrence instance.
*/
export function setInterval(callback: () => void, time: ScheduleData): Timer;
/**
* time period information provider.
*/
export const time: TimePeriod;
export const t: TimePeriod;
/**
* Second time period information provider.
*/
export const second: TimePeriod;
export const s: TimePeriod;
/**
* Minute time period information provider.
*/
export const minute: TimePeriod;
export const m: TimePeriod;
/**
* Hour time period information provider.
*/
export const hour: TimePeriod;
export const h: TimePeriod;
/**
* Day time period information provider.
*/
export const day: TimePeriod;
export const D: TimePeriod;
/**
* Day of week time period information provider.
*/
export const dayOfWeek: TimePeriod;
export const dw: TimePeriod;
export const d: TimePeriod;
/**
* Day of week in month time period information provider.
*/
export const dayOfWeekCount: TimePeriod;
export const dc: TimePeriod;
/**
* Day in year time period information provider.
*/
export const dayOfYear: TimePeriod;
export const dy: TimePeriod;
/**
* Week of month time period information provider.
*/
export const weekOfMonth: TimePeriod;
export const wm: TimePeriod;
/**
* Week of year from ISO 8601 time period information provider.
*/
export const weekOfYear: TimePeriod;
export const wy: TimePeriod;
/**
* Month time period information provider.
*/
export const month: TimePeriod;
export const M: TimePeriod;
/**
* Year time period information provider.
*/
export const year: TimePeriod;
export const Y: TimePeriod;
/**
* Full date time period information provider.
*/
export const fullDate: TimePeriod;
export const fd: TimePeriod;
/**
* Constant for the number of milliseconds in a second.
*/
export const SEC: 1000;
/**
* Constant for the number of milliseconds in a minute.
*/
export const MIN: 60_000;
/**
* Constant for the number of milliseconds in an hour.
*/
export const HOUR: 3_600_000;
/**
* Constant for the number of milliseconds in a day.
*/
export const DAY: 86_400_000;
/**
* Constant for the number of milliseconds in a week.
*/
export const WEEK: 604_800_000;
/**
* Constant for the number of days in each month.
*/
export const DAYS_IN_MONTH: [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31];
/**
* Constant for never.
*/
export const NEVER: 0;

View File

@@ -0,0 +1,26 @@
{
"compilerOptions": {
"module": "commonjs",
"lib": [
"es6"
],
"noImplicitAny": true,
"noImplicitThis": true,
"strictFunctionTypes": true,
"strictNullChecks": true,
"baseUrl": "../",
"typeRoots": [
"../"
],
"paths":{
"@breejs/*": ["breejs__*"]
},
"types": [],
"noEmit": true,
"forceConsistentCasingInFileNames": true
},
"files": [
"index.d.ts",
"breejs__later-tests.ts"
]
}

View File

@@ -0,0 +1 @@
{ "extends": "@definitelytyped/dtslint/dt.json" }