nodejs-polars
    Preparing search index...

    Interface DateFunctions<T>

    Functions that can be applied to a Date or Datetime column.

    interface DateFunctions<T> {
        day(): T;
        hour(): T;
        minute(): T;
        month(): T;
        nanosecond(): T;
        ordinalDay(): T;
        second(): T;
        strftime(fmt: string): T;
        timestamp(): T;
        week(): T;
        weekday(): T;
        year(): T;
    }

    Type Parameters

    • T

    Hierarchy (View Summary)

    Index

    Methods

    day hour minute month nanosecond ordinalDay second strftime timestamp week weekday year

    Methods

    • Extract day from underlying Date representation. Can be performed on Date and Datetime.

      Returns the day of month starting from 1. The return value ranges from 1 to 31. (The last day of month differs by months.)

      Returns T

      day as pl.UInt32

    • Extract hour from underlying DateTime representation. Can be performed on Datetime.

      Returns the hour number from 0 to 23.

      Returns T

      Hour as UInt32

    • Extract minutes from underlying DateTime representation. Can be performed on Datetime.

      Returns the minute number from 0 to 59.

      Returns T

      minute as UInt32

    • Extract month from underlying Date representation. Can be performed on Date and Datetime.

      Returns the month number starting from 1. The return value ranges from 1 to 12.

      Returns T

      Month as UInt32

    • Extract seconds from underlying DateTime representation. Can be performed on Datetime.

      Returns the number of nanoseconds since the whole non-leap second. The range from 1,000,000,000 to 1,999,999,999 represents the leap second.

      Returns T

      Nanosecond as UInt32

    • Extract ordinal day from underlying Date representation. Can be performed on Date and Datetime.

      Returns the day of year starting from 1. The return value ranges from 1 to 366. (The last day of year differs by years.)

      Returns T

      Day as UInt32

    • Extract seconds from underlying DateTime representation. Can be performed on Datetime.

      Returns the second number from 0 to 59.

      Returns T

      Second as UInt32

    • Extract the week from the underlying Date representation. Can be performed on Date and Datetime

      Returns the ISO week number starting from 1. The return value ranges from 1 to 53. (The last week of year differs by years.)

      Returns T

      Week number as UInt32

    • Extract the week day from the underlying Date representation. Can be performed on Date and Datetime.

      Returns the weekday number where monday = 0 and sunday = 6

      Returns T

      Week day as UInt32

    • Extract year from underlying Date representation. Can be performed on Date and Datetime.

      Returns the year number in the calendar date.

      Returns T

      Year as Int32

    Settings

    Member Visibility

    On This Page

    Methods