paprika.time — paprika 0.1.2

< clj/s

(< & args)

<= clj/s

(<= & args)

= clj/s

(= & args)

> clj/s

(> & args)

>= clj/s

(>= & args)

abuts? clj

(abuts? i-a i-b)

Returns true if Interval i-a abuts i-b, i.e. then end of i-a is exactly the beginning of i-b.

after? clj

(after? this that)

Returns true if ReadableDateTime 'this' is strictly after date/time 'that'.

ago clj/s≠

clj

(ago period)

Returns a DateTime a supplied period before the present. e.g. (-> 5 years ago)

cljs

as-local clj/s

(as-local date)

as-utc clj/s

(as-utc date)

at-midnight cljs

available-ids clj

(available-ids)

Returns a set of available IDs for use with time-zone-for-id.

before? clj

(before? this that)

Returns true if ReadableDateTime 'this' is strictly before date/time 'that'.

conversion-error cljs

date-midnight clj/s≠

clj

(date-midnight year)

(date-midnight year month)

(date-midnight year month day)

Constructs and returns a new DateMidnight in UTC. Specify the year, month of year, day of month. Note that month and day are 1-indexed. Any number of least-significant components can be ommited, in which case they will default to 1.

cljs

date-time clj/s≠

clj

(date-time year)

(date-time year month)

(date-time year month day)

(date-time year month day hour)

(date-time year month day hour minute)

(date-time year month day hour minute second)

(date-time year month day hour minute second millis)

Constructs and returns a new DateTime in UTC. Specify the year, month of year, day of month, hour of day, minute of hour, second of minute, and millisecond of second. Note that month and day are 1-indexed while hour, second, minute, and millis are 0-indexed. Any number of least-significant components can be ommited, in which case they will default to 1 or 0 as appropriate.

cljs

date? cljs

DateTimeProtocol clj

Interface for various date time functions

day clj/s≠

clj

(day this)

Return the day of month component of the given date/time.

cljs

day-of-week clj/s≠

clj

(day-of-week this)

Return the day of week component of the given date/time. Monday is 1 and Sunday is 7

cljs

days clj/s≠

clj

(days)

(days n)

Given a number, returns a Period representing that many days. Without an argument, returns a PeriodType representing only days.

cljs

days? clj/s≠

clj

(days? val)

Returns true if the given value is an instance of Days

cljs

default-ms-fn cljs

default-time-zone clj/s≠

clj

(default-time-zone)

Returns the default DateTimeZone for the current environment.

cljs

deprecated clj/s≠

clj

(deprecated message)

cljs

do-at clj macro

(do-at base-date-time & body)

Like clojure.core/do except evalautes the expression at the given date-time

do-at* clj/s≠

clj

(do-at* base-date-time body-fn)

cljs

earliest clj/s≠

clj

(earliest dts)

(earliest dt1 dt2)

Returns the earliest of the supplied DateTimes

cljs

end clj/s≠

clj

(end in)

Returns the end DateTime of an Interval.

cljs

epoch clj/s≠

clj

(epoch)

Returns a DateTime for the beginning of the Unix epoch in the UTC time zone.

cljs

equal? clj

(equal? this that)

Returns true if ReadableDateTime 'this' is strictly equal to date/time 'that'.

extend clj/s≠

clj

(extend in & by)

Returns an Interval with an end ReadableDateTime the specified Period after the end of the given Interval

cljs

first-day-of-the-month clj/s≠

clj

(first-day-of-the-month dt)

(first-day-of-the-month year month)

cljs

first-day-of-the-month- clj

(first-day-of-the-month- this)

Returns the first day of the month

floor clj/s≠

clj

(floor dt dt-fn)

Floors the given date-time dt to the given time unit dt-fn, e.g. (floor (now) hour) returns (now) for all units up to and including the hour

cljs

format-for clj/s

from-default-time-zone cljs

from-now clj/s≠

clj

(from-now period)

Returns a DateTime a supplied period after the present. e.g. (-> 30 minutes from-now)

cljs

from-sql clj

(from-sql time)

from-string clj/s

from-string-local clj/s

(from-string-local string)

from-string-local-macro clj

(from-string-local-macro str)

from-string-macro clj/s

(from-string-macro str)

from-time-zone clj

(from-time-zone dt tz)

Returns a new ReadableDateTime corresponding to the same point in calendar time as the given ReadableDateTime, but for a correspondingly different absolute instant in time.

from-timestamp-local-macro clj

(from-timestamp-local-macro string)

from-timestamp-macro clj

(from-timestamp-macro string)

from-utc-time-zone cljs

hour clj/s≠

clj

(hour this)

Return the hour of day component of the given date/time. A time of 12:01am will have an hour component of 0.

cljs

hours clj/s≠

clj

(hours)

(hours n)

Given a number, returns a Period representing that many hours. Without an argument, returns a PeriodType representing only hours.

cljs

hours? clj/s≠

clj

(hours? val)

Returns true if the given value is an instance of Hours

cljs

in-days clj

(in-days this)

Return the time in days.

in-hours clj

(in-hours this)

Return the time in hours.

in-millis clj

(in-millis this)

Return the time in milliseconds.

in-minutes clj

(in-minutes this)

Return the time in minutes.

in-months clj

(in-months this)

Return the time in months

in-msecs clj deprecated

(in-msecs in)

DEPRECATED: Returns the number of milliseconds in the given Interval.

in-seconds clj

(in-seconds this)

Return the time in seconds.

in-secs clj deprecated

(in-secs in)

DEPRECATED: Returns the number of standard seconds in the given Interval.

in-weeks clj

(in-weeks this)

Return the time in weeks

in-years clj

(in-years this)

Return the time in years

interval clj/s≠

clj

(interval dt-a dt-b)

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

cljs

interval? cljs

InTimeUnitProtocol clj

Interface for in-<time unit> functions

last-day-of-the-month clj/s≠

clj

(last-day-of-the-month dt)

(last-day-of-the-month year month)

cljs

last-day-of-the-month- clj

(last-day-of-the-month- this)

Returns the last day of the month

latest clj/s≠

clj

(latest dts)

(latest dt1 dt2)

Returns the latest of the supplied DateTimes

cljs

local-date clj/s≠

clj

(local-date year month day)

Constructs and returns a new LocalDate. Specify the year, month, and day. Does not deal with timezones.

cljs

local-date-time clj/s≠

clj

(local-date-time year)

(local-date-time year month)

(local-date-time year month day)

(local-date-time year month day hour)

(local-date-time year month day hour minute)

(local-date-time year month day hour minute second)

(local-date-time year month day hour minute second millis)

Constructs and returns a new LocalDateTime. Specify the year, month of year, day of month, hour of day, minute of hour, second of minute, and millisecond of second. Note that month and day are 1-indexed while hour, second, minute, and millis are 0-indexed. Any number of least-significant components can be ommited, in which case they will default to 1 or 0 as appropriate.

cljs

local-time clj

(local-time hour)

(local-time hour minute)

(local-time hour minute second)

(local-time hour minute second millis)

Constructs and returns a new LocalTime. Specify the hour of day, minute of hour, second of minute, and millisecond of second. Any number of least-significant components can be ommited, in which case they will default to 1 or 0 as appropriate.

max-date clj

(max-date dt & dts)

Maximum of the provided DateTimes.

milli clj/s≠

clj

(milli this)

Return the millisecond of second component of the given date/time.

cljs

millis clj/s≠

clj

(millis)

(millis n)

Given a number, returns a Period representing that many milliseconds. Without an argument, returns a PeriodType representing only milliseconds.

cljs

min-date clj

(min-date dt & dts)

Minimum of the provided DateTimes.

mins-ago clj/s≠

clj

(mins-ago d)

cljs

minus clj/s≠

clj

(minus dt p)

(minus dt p & ps)

Returns a new date/time object corresponding to the given date/time moved backwards by the given Period(s).

cljs

minus- clj

(minus- this period)

Returns a new date/time corresponding to the given date/time moved backwards by the given Period(s).

minute clj/s≠

clj

(minute this)

Return the minute of hour component of the given date/time.

cljs

minutes clj/s≠

clj

(minutes)

(minutes n)

Given a number, returns a Period representing that many minutes. Without an argument, returns a PeriodType representing only minutes.

cljs

minutes? clj/s≠

clj

(minutes? val)

Returns true if the given value is an instance of Minutes

cljs

month clj/s≠

clj

(month this)

Return the month component of the given date/time.

cljs

months clj/s≠

clj

(months)

(months n)

Given a number, returns a Period representing that many months. Without an argument, returns a PeriodType representing only months.

cljs

months? clj/s≠

clj

(months? val)

Returns true if the given value is an instance of Months

cljs

now clj/s≠

clj

(now)

Returns a DateTime for the current instant in the UTC time zone.

cljs

nth-day-of-the-month clj

(nth-day-of-the-month dt n)

(nth-day-of-the-month year month n)

Returns the nth day of the month.

number-of-days-in-the-month clj/s≠

clj

(number-of-days-in-the-month dt)

(number-of-days-in-the-month year month)

cljs

offset-ms-fn cljs

overlap clj/s≠

clj

(overlap i-a i-b)

Returns an Interval representing the overlap of the specified Intervals. Returns nil if the Intervals do not overlap. The first argument must not be nil. If the second argument is nil then the overlap of the first argument and a zero duration interval with both start and end times equal to the current time is returned.

cljs

overlaps? clj/s≠

clj

(overlaps? i-a i-b)

(overlaps? start-a end-a start-b end-b)

With 2 arguments: Returns true of the two given Intervals overlap. Note that intervals that satisfy abuts? do not satisfy overlaps? With 4 arguments: Returns true if the range specified by start-a and end-a overlaps with the range specified by start-b and end-b.

cljs

parse clj/s

(parse string format)

parse-local clj/s

(parse-local string format)

period cljs

period-fn cljs

period-fns cljs

period-type? cljs

period? cljs

periods cljs

plus clj/s≠

clj

(plus dt p)

(plus dt p & ps)

Returns a new date/time corresponding to the given date/time moved forwards by the given Period(s).

cljs

plus- clj

(plus- this period)

Returns a new date/time corresponding to the given date/time moved forwards by the given Period(s).

sec clj/s≠

clj

(sec this)

Return the second of minute component of the given date/time.

cljs

second clj/s≠

clj

(second this)

Return the second of minute component of the given date/time.

cljs

seconds clj/s≠

clj

(seconds)

(seconds n)

Given a number, returns a Period representing that many seconds. Without an argument, returns a PeriodType representing only seconds.

cljs

seconds? clj/s≠

clj

(seconds? val)

Returns true if the given value is an instance of Seconds

cljs

secs clj deprecated

(secs)

(secs n)

DEPRECATED

secs? clj deprecated

(secs? val)

DEPRECATED

start clj/s≠

clj

(start in)

Returns the start DateTime of an Interval.

cljs

static-ms-fn cljs

Time clj/s

time-now clj/s≠

clj

(time-now)

Returns a LocalTime for the current instant without date or time zone using ISOChronology in the current time zone.

cljs

time-zone-for-id clj

(time-zone-for-id id)

Returns a DateTimeZone for the given ID, which must be in long form, e.g. 'America/Matamoros'.

time-zone-for-offset clj/s≠

clj

(time-zone-for-offset hours)

(time-zone-for-offset hours minutes)

Returns a DateTimeZone for the given offset, specified either in hours or hours and minutes.

cljs

to-default-time-zone cljs

to-local clj/s

(to-local date)

to-sql clj

to-time-zone clj

(to-time-zone dt tz)

Returns a new ReadableDateTime corresponding to the same absolute instant in time as the given ReadableDateTime, but with calendar fields corresponding to the given TimeZone.

to-utc clj/s≠

clj

(to-utc date)

cljs

today clj/s≠

clj

(today)

Constructs and returns a new LocalDate representing today's date. LocalDate objects do not deal with timezones at all.

cljs

today-at clj/s≠

clj

(today-at hours minutes)

(today-at hours minutes seconds)

(today-at hours minutes seconds millis)

cljs

today-at-midnight clj/s≠

clj

(today-at-midnight)

(today-at-midnight tz)

DEPRECATED: Please use with-time-at-start-of-day instead. See http://goo.gl/nQCmKd Returns a DateMidnight for today at midnight in the UTC time zone.

cljs

unparse clj/s

(unparse date format)

unparse-local clj/s

(unparse-local date format)

utc clj/s≠

clj

DateTimeZone for UTC.

week-number-of-year clj/s≠

clj

(week-number-of-year this)

Returs the number of weeks in the year

cljs

weeks clj/s≠

clj

(weeks)

(weeks n)

Given a number, returns a Period representing that many weeks. Without an argument, returns a PeriodType representing only weeks.

cljs

weeks? clj/s≠

clj

(weeks? val)

Returns true if the given value is an instance of Weeks

cljs

with-time-at-start-of-day clj

(with-time-at-start-of-day dt)

Returns a DateTime representing the start of the day. Normally midnight, but not always true, as in some time zones with daylight savings.

within? clj/s≠

clj

(within? i dt)

(within? start end test)

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

cljs

year clj/s≠

clj

(year this)

Return the year component of the given date/time.

cljs

year-month clj

(year-month year)

(year-month year month)

Constructs and returns a new YearMonth. Specify the year and month of year. Month is 1-indexed and defaults to January (1).

years clj/s≠

clj

(years)

(years n)

Given a number, returns a Period representing that many years. Without an argument, returns a PeriodType representing only years.

cljs

years? clj/s≠

clj

(years? val)

Returns true if the given value is an instance of Years

cljs

yesterday clj/s≠

clj

(yesterday)

Returns a DateTime for yesterday relative to now

cljs