UNPKG

@burglekitt/gmt

Version:

Temporal-based date and time utilities with timezone support and polyfill integration

28 lines (27 loc) 1.7 kB
/** * Split a Unix epoch interval into `n` equal-length sub-intervals. * * - Returns an array of `n` `{ start, end }` records that tile the original interval, each * record's `end` equal to the next record's `start`. * - Boundaries are computed as plain numeric arithmetic on the epoch values — no timeZone is * involved, so the split is exact whenever the total divides evenly by `n`. * - `n === 1` returns the original interval unchanged, as a single-element array. * - A zero-length interval (`start === end`) returns `n` identical zero-length sub-intervals. * - Returns `[]` when `n` is not a positive integer, or on invalid input (non-finite/non-integer * start/end, `start > end`). * * @param start Unix epoch value (seconds or milliseconds) — interval start * @param end Unix epoch value (seconds or milliseconds) — interval end * @param n number of equal sub-intervals to produce (positive integer) * @returns array of `n` `{ start, end }` records, or `[]` on invalid input * * @example intervalDivideEquallyUnix(0, 90000000, 3) // [{ start: 0, end: 30000000 }, { start: 30000000, end: 60000000 }, { start: 60000000, end: 90000000 }] * @example intervalDivideEquallyUnix(0, 100000000, 3) // [{ start: 0, end: 33333333 }, { start: 33333333, end: 66666667 }, { start: 66666667, end: 100000000 }] * @example intervalDivideEquallyUnix(0, 90000000, 1) // [{ start: 0, end: 90000000 }] * @example intervalDivideEquallyUnix(0, 90000000, 0) // [] * @example intervalDivideEquallyUnix(NaN, 90000000, 3) // [] */ export declare function intervalDivideEquallyUnix(start: number | string, end: number | string, n: number): Array<{ start: number; end: number; }>;