Class TimeSeries

src/danfojs-base/core/datetime.ts:25–261

 * @param data Series or Array of date strings
 */
export default class TimeSeries implements DateTime {
    private $dateObjectArray: Array<Date>

    constructor(data: Series | ArrayType1D) {
        if (data instanceof Series) {
            this.$dateObjectArray = this.processData(data.values as ArrayType1D)
        } else {
            this.$dateObjectArray = this.processData(data)
        }
    }

    /**
     * Processed the data values into internal structure for easy access
     * @param dateArray An array of date strings
    */
    private processData(dateArray: ArrayType1D): Array<Date> {
        const values = dateArray.map(dateString => new Date(`${dateString}`))
        return values
    }

    /**
     *  Returns the month, in local time.
     * @example
     * ```
     * import { Series } from "danfojs-node"
     * const data = [
     * "2019-01-01",
     * "2019-02-01",
     * "2019-03-01",
     * "2019-04-01",
     * ]
     * const df = new Series(data)
     * const dfNew = df.dt.month()
     * console.log(dfNew.values)
     * // [1, 2, 3, 4]
     * ```
    */
    month(): Series {
        const newValues = this.$dateObjectArray.map(date => date.getMonth())
        return new Series(newValues);
    }

    /**
     * Returns the day of the week, in local time
     * @example
     * ```
     * import { Series } from "danfojs-node"
     * const data = [
     * "2019-01-01",
     * "2019-02-01",
     * "2019-03-01",
     * "2019-04-01",
     * ]
     * const df = new Series(data)
     * const dayOfWeek = df.dt.dayOfWeek()
     * console.log(dayOfWeek.values)
     * ```
    */