toolbelt.date — starcity/toolbelt-date 0.5.0

< clj

(< date & more)

Returns true if dates are in monotonically increasing order, otherwise false.

Arguments are date instances of any type (e.g. timestamp, java-date, date/time etc.)

<= clj

(<= date & more)

Returns true if dates are in monotonically non-decreasing order, otherwise false.

Arguments are date instances of any type (e.g. timestamp, java-date, date/time etc.)

> clj

(> date & more)

Returns true if dates are in monotonically decreasing order, otherwise false.

Arguments are date instances of any type (e.g. timestamp, java-date, date/time etc.)

>= clj

(>= date & more)

Returns true if dates are in monotonically non-increasing order, otherwise false.

Arguments are date instances of any type (e.g. timestamp, java-date, date/time etc.)

beginning-of-day clj

(beginning-of-day & args__2042__auto__)

Compatibility alias for start-of-day-local

beginning-of-month clj

(beginning-of-month & args__2042__auto__)

Compatibility alias for start-of-month-local

day clj

(day date)

Return the day of month component of the given date.

'date' is a date instance of any type (e.g. timestamp, java-date, date/time etc.)

days clj

(days n)

Given a number, returns a Period representing that many days.

days-in-month clj

(days-in-month date)

(days-in-month date timezone)

Takes a date in UTC time and returns the number of days in the month of the local time in timezone the date represents.

defdeprecated clj macro

(defdeprecated old new)

Helper macro to def deprecated functions and invoke the new implementation. Taken from leiningen: https://github.com/technomancy/leiningen/commit/6e18fc495d485acb6942d08f3719a644f697bf27

end-of-day clj

(end-of-day & args__2042__auto__)

Compatibility alias for end-of-day-local

end-of-day-local clj

(end-of-day-local date)

(end-of-day-local date tz)

Given a date in local time UTC, returns a new date representing the time 23:59:59 in timezone 'tz' of the same day. Arity 1: Adjust date to UTC (will be unchanged when input date is in UTC). Arity 2: Adjust date with respect to timezone tz. 'date' is a date instance as per 'toolbelt.date/transform'.

end-of-day-utc clj

(end-of-day-utc date)

(end-of-day-utc date timezone)

(end-of-day-utc date from-tz to-tz)

Takes a 'date' in UTC time representing a time in 'timezone', and returns a UTC corrected date representing the end of day of the local date in 'timezone'.

Note: Will convert 'date' to local time in 'timezone' before calculating end of day, input should be in UTC. E.g. 'date' represents Oct 12 at 23:00 in Pacific time so the input will be Oct 13 at 06:00. Returned will be Oct 13 at 06:59:59, which represents end of day of Oct 12 in Pacific time 'timezone'. Arity 1: Adjust date from and to UTC timezone. Arity 2: Adjust date from and to the supplied timezone. Arity 3: Adjust date from from-tz and return a new date represented in to-tz.

end-of-month clj

(end-of-month & args__2042__auto__)

Compatibility alias for end-of-month-local

end-of-month-local clj

(end-of-month-local date)

(end-of-month-local date tz)

Given a date in local time UTC, returns a new date representing the last of the month at 23:59:59 in timezone 'tz' of the same month. Arity 1: Adjust date to UTC (will be unchanged when input date is in UTC). Arity 2: Adjust date with respect to timezone tz. 'date' is a date instance as per 'toolbelt.date/transform'.

end-of-month-utc clj

(end-of-month-utc date)

(end-of-month-utc date timezone)

(end-of-month-utc date from-tz to-tz)

Takes a 'date' in UTC time representing a time in 'timezone', and returns the UTC corrected end of the month of the local date in 'timezone'.

Note: Will convert 'date' to local time in 'timezone' before calculating start of month, input should be in UTC. E.g. 'date' represents Oct 31 at 23:00 in Pacific time so the input will be Nov 1 at 06:00. Returned will be Oct 1 at 06:59:59, which represents Oct 31 23:59:59 in Pacific time 'timezone'. Arity 1: Adjust date from and to UTC timezone. Arity 2: Adjust date from and to the supplied timezone. Arity 3: Adjust date from from-tz and return a new date represented in to-tz.

from-map clj

(from-map params)

Returns a date given a map with keys and values representing a date time. Considers the following keys: #{:year :month :day :hour :minute :second :millisecond} with corresponding number values when creating the date.

from-tz-date clj

(from-tz-date & args__2042__auto__)

Compatibility alias for tz-uncorrected

from-tz-date-time clj

(from-tz-date-time & args__2042__auto__)

Compatibility alias for tz-uncorrected

from-unix-time-millis clj

(from-unix-time-millis millis)

Return a date given the supplied number of millseconds millis since the UNIX time.

from-unix-time-secs clj

(from-unix-time-secs secs)

Return a date given the supplied number of seconds millis since the UNIX time.

in clj

(in unit p)

Return the interval or period p in unit specified by a keyword: #{:years :months :days :weeks :hours :minutes :seconds :millis}

in-days clj

(in-days p)

Return the interval or period in days.

in-months clj

(in-months p)

Return the interval or period in months.

interval clj

(interval from to)

Returns an interval representing the span between the two given dates. Note that intervals are closed on the left and open on the right.

'from' and 'to' are date instances of any type where 'from' is before 'to'.

is-first-day-of-month? clj

(is-first-day-of-month? d)

max clj

(max date & more)

Returns the largest date, i.e. the latest in time.

min clj

(min date & more)

Returns the smallest date, i.e. the earliest in time.

minus clj

(minus period)

(minus date period)

Transforms a given date and returns a new java.util.Date moved backwards by the given Period(s). Arity 1 version: moved backwards from System/currentTimeMillis.

'date' is a date instance as per 'toolbelt.date/transform'.

month clj

(month date)

Return the month component of the given date.

'date' is a date instance of any type (e.g. timestamp, java-date, date/time etc.)

months clj

(months n)

Given a number, returns a Period representing that many months.

next-day clj

(next-day date)

next-month clj

(next-month date)

overlap clj

(overlap i1 i2)

Returns an interval representing the overlap between the two supplied intervals.

period clj

(period &
        {:keys [years months days weeks hours minutes seconds millis]
         :as keyvals})

Given some keys with values, returns a Period that represents that amount of time.

E.g. (period :months 2 :days 1) returns a Period representing a time period of 2 months and 2 days.

Possible keys are: #{:years :months :days :weeks :hours :minutes :seconds :millis}

plus clj

(plus period)

(plus date period)

Transforms a given date and returns a new java.util.Date moved forwards by the given Period(s). Arity 1 version: moved forwards from System/currentTimeMillis.

'date' is a date instance as per 'toolbelt.date/transform'.

short clj

(short date & [include-time])

short-date clj

(short-date & args__2042__auto__)

Compatibility alias for short

short-date-time clj

(short-date-time & args__2042__auto__)

Compatibility alias for short

start-of-day-local clj

(start-of-day-local date)

(start-of-day-local date tz)

Given a date in local time UTC, returns a new date representing the time 00:00:00 in timezone 'tz' of the same day. Arity 1: Adjust date to UTC (will be unchanged when input date is in UTC). Arity 2: Adjust date with respect to timezone tz. 'date' is a date instance as per 'toolbelt.date/transform'.

start-of-day-utc clj

(start-of-day-utc date)

(start-of-day-utc date timezone)

(start-of-day-utc date from-tz to-tz)

Takes a 'date' in UTC time representing a time in 'timezone', and returns the UTC corrected start of day of the local date in 'timezone'.

Note: Will convert 'date' to local time in 'timezone' before calculating start of day, input should be in UTC. E.g. 'date' represents Oct 12 at 23:00 in Pacific time so the input will be Oct 13 at 06:00. Returned will be Oct 12 at 07:00, which represents start of day of Oct 12 in Pacific time 'timezone'.

start-of-month-local clj

(start-of-month-local date)

(start-of-month-local date tz)

Given a date in local time UTC, returns a new date representing the 1st of the month at 00:00:00 in timezone 'tz' of the same month. Arity 1: Adjust date to UTC (will be unchanged when input date is in UTC). Arity 2: Adjust date with respect to timezone tz. 'date' is a date instance as per 'toolbelt.date/transform'.

start-of-month-utc clj

(start-of-month-utc date)

(start-of-month-utc date timezone)

(start-of-month-utc date from-tz to-tz)

Takes a 'date' in UTC time representing a time in 'timezone', and returns the UTC corrected start of the month of the local date in 'timezone'.

Note: Will convert 'date' to local time in 'timezone' before calculating start of month, input should be in UTC. E.g. 'date' represents Oct 31 at 23:00 in Pacific time so the input will be Nov 1 at 06:00. Returned will be Oct 1 at 07:00, which represents start of Oct in Pacific time 'timezone'.

to-date clj

(to-date date)

Coerce to date.

to-map clj

(to-map date)

Returns a map with keys and values representing the supplied date. The returned map includes the following keys: #{:year :month :day :hour :minute :second :millisecond :day-of-week :week-of-year} with corresponding number values.

to-unix-time clj

(to-unix-time dt)

(to-unix-time dt unit)

Return the number of seconds after the Unix time Arity 1: returns the number of milliseconds after Unix time. Arity 2: returns the time in unit after Unix time: #{:millis :seconds}

to-utc-corrected-date clj

(to-utc-corrected-date & args__2042__auto__)

Compatibility alias for tz-corrected

to-utc-corrected-date-time clj

(to-utc-corrected-date-time & args__2042__auto__)

Compatibility alias for tz-corrected

transform clj

(transform d f & args)

'Transforms' a date where 'd' is a date of any type (timestamp, org.joda.DateTime, java.util.Date. etc), and returns a java.util.Date, after applying a transformation function 'f', which is a function that takes a date/time instance and any supplied args and returns a date.

tz-corrected clj

(tz-corrected inst tz)

Produce the UTC instant in time relative to timezone tz.

tz-corrected-dt clj

(tz-corrected-dt dt tz)

tz-uncorrected clj

(tz-uncorrected inst tz)

Produce the absolute UTC instant from timezone tz.

tz-uncorrected-dt clj

(tz-uncorrected-dt dt tz)

within? clj

(within? interval test)

(within? start end test)

With 2 arguments: Returns true if the given Interval contains the given date. Note that if the date is exactly equal to the end of the interval, this function returns false. With 3 arguments: Returns true if the start date is equal to or before and the end date is equal to or after the test ReadablePartial.

year clj

(year date)

Return the year component of the given date.

'date' is a date instance of any type (e.g. timestamp, java-date, date/time etc.)