caldate

> calendar date for date-holidays


Table of Contents

* Class: CalDate
* new CalDate(opts)
* CalDate.set(opts)
* CalDate.isEqualDate(calDate)
* CalDate.getDay()
* CalDate.setOffset(number, unit)
* CalDate.setTime(hour, minute, second)
* CalDate.setDuration(duration)
* CalDate.update()
* CalDate.toEndDate()
* CalDate.toTimezone(timezone)
* CalDate.toDate()
* CalDate.toISOString()
* CalDate.toString()
* Contribution and License Agreement
* License
* References

Class: CalDate

$3

constructs a new CalDate instance

Parameters

opts: Object | Date, See set(opts)

Example:
``js
// ES5
import CalDate from 'caldate'
// cjs
const CalDate = require('caldate')

const caldate = new CalDate('2000-01-01 12:00:00')
caldate.year
//> 2000
caldate.month
//> 1
`

$3

set calendar date

Parameters

opts: Object | Date, defaults to 1900-01-01

opts.year: String, set calendar date

opts.month: String, January equals to 1, December to 12

opts.day: String, set calendar date

opts.hour: String, set calendar date

opts.minute: String, set calendar date

opts.second: String, set calendar date

opts.duration: String, defaults to 24 hours

$3

checks if Date is equal to calDate

Parameters

calDate: CalDate, checks if Date is equal to calDate

Returns: Boolean, true if date matches

$3

get day of week

Returns: Number, day of week 0=sunday, 1=monday, ...

$3

set offset per unit

Parameters

number: Number, set offset per unit

unit: String, Unit in days d, hours h, minutes m

Returns: Object, this

$3

set time per hour, minute or second while maintaining duration at midnight

Parameters

hour: Number, set time per hour, minute or second while maintaining duration at midnight

minute: Number, set time per hour, minute or second while maintaining duration at midnight

second: Number, set time per hour, minute or second while maintaining duration at midnight

Returns: Object, this

$3

set duration in hours

Parameters

duration: Number, in hours

Returns: Object, this

$3

update internal data to real date

Returns: Object, this

$3

get end date of calendar date

Returns: CalDate

$3

move internal date to a date in timezone

Parameters

timezone: String, e.g. 'America/New_York'

Returns: Date

$3

set date from a given timezone

Parameters

dateUTC: Date, date in UTC

timezone: String, timezone of dateUTC, e.g. 'America/New_York'

Returns: CalDate self

$3

convert to Date

Returns: Date

$3

get Date in ISO format

$3

get Date as String YYYY-MM-DD HH:MM:SS

Contribution and License Agreement

If you contribute code to this project, you are implicitly allowing your
code to be distributed under the ISC license. You are also implicitly
verifying that all code is your original work or correctly attributed
with the source of its origin and licence.

License

Copyright (c) 2016 commenthol (ISC License)

See [LICENSE][] for more information.

References

* [LICENSE][LICENSE]

[LICENSE]: ./LICENSE