redis-time-series-ts/lib/entity/timestampRange.d.ts

Javascript RedisTimeSeries client

import { StringNumberArray } from "../index";
/**
 * A `from` - `to` timestamp object
 */
export declare class TimestampRange {
    private from;
    private to;
    /**
     *  Creates a timestamp range object
     *
     * @param from timestamp to begin from (milliseconds)
     * @param to timestamp to end at (milliseconds)
     *
     * @remarks
     * ```
     *     // Example
     *     const oneDayAgo = new Date().getTime() - 24 * 3600 * 1000
     *     const now = new Date().getTime()
     *     const tsRange = new TimestampRange(oneDayAgo, now)
     *     tsRange.getFrom() // oneDayAgo
     *     tsRange.getTo() // now
     *     tsRange.setFrom(oneDayAgo - 24 * 3600 * 1000) // twoDaysAgo
     *     tsRange.getTo(oneDayAgo) // oneDayAgo
     *     tsRange.flatten() // [twoDaysAgo, oneDayAgo]
     * ```
     */
    constructor(from?: number, to?: number);
    getFrom(): string | number;
    setFrom(from?: number): TimestampRange;
    getTo(): string | number;
    setTo(to?: number): TimestampRange;
    flatten(): StringNumberArray;
    protected validateTimestamp(timestamp: number): number;
}
//# sourceMappingURL=timestampRange.d.ts.map