@the-/date
==========

<!---
This file is generated by @the-/templates. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![npm Version][bd_npm_shield_url]][bd_npm_url]

[bd_repo_url]: https://github.com/the-labo/the
[bd_npm_url]: http://www.npmjs.org/package/@the-/date
[bd_npm_shield_url]: http://img.shields.io/npm/v/@the-/date.svg?style=flat

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Date utility for the-framework

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>




<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/readme/01.Installation.md.hbs" Start -->

<a name="section-doc-readme-01-installation-md"></a>

Installation
-----

```bash
$ npm install @the-/date --save
```


<!-- Section from "doc/readme/01.Installation.md.hbs" End -->

<!-- Section from "doc/readme/02.Usage.md.hbs" Start -->

<a name="section-doc-readme-02-usage-md"></a>

Usage
---------

```javascript
'use strict'

const theDate = require('@the-/date')

async function tryExample() {
  console.log(theDate().addHours(3).toDate()) // 3 hours later

  const date = theDate('2016/10/10', { lang: 'ja' })
  console.log(date.format('lll')) // -> "2016年10月10日 00:00"
}

tryExample().catch((err) => console.error(err))

```


<!-- Section from "doc/readme/02.Usage.md.hbs" End -->


<!-- Sections Start -->

<a name="api"></a>

## API Guide


- AddMixed
  - [#add(amount,unit)](./doc/api/api.md#AddMixed#add)
  - [#addDay(day)](./doc/api/api.md#AddMixed#addDay)
  - [#addDays(days)](./doc/api/api.md#AddMixed#addDays)
  - [#addHour(hour)](./doc/api/api.md#AddMixed#addHour)
  - [#addHours(hours)](./doc/api/api.md#AddMixed#addHours)
  - [#addMillisecond(millisecond)](./doc/api/api.md#AddMixed#addMillisecond)
  - [#addMilliseconds(milliseconds)](./doc/api/api.md#AddMixed#addMilliseconds)
  - [#addMinute(minute)](./doc/api/api.md#AddMixed#addMinute)
  - [#addMinutes(minutes)](./doc/api/api.md#AddMixed#addMinutes)
  - [#addMonth(month)](./doc/api/api.md#AddMixed#addMonth)
  - [#addMonths(months)](./doc/api/api.md#AddMixed#addMonths)
  - [#addQuarter(quarter)](./doc/api/api.md#AddMixed#addQuarter)
  - [#addQuarters(quarters)](./doc/api/api.md#AddMixed#addQuarters)
  - [#addSecond(second)](./doc/api/api.md#AddMixed#addSecond)
  - [#addSeconds(seconds)](./doc/api/api.md#AddMixed#addSeconds)
  - [#addWeek(week)](./doc/api/api.md#AddMixed#addWeek)
  - [#addWeeks(weeks)](./doc/api/api.md#AddMixed#addWeeks)
  - [#addYear(year)](./doc/api/api.md#AddMixed#addYear)
  - [#addYears(years)](./doc/api/api.md#AddMixed#addYears)
- EndOfMixed
  - [#endOf(unit)](./doc/api/api.md#EndOfMixed#endOf)
  - [#endOfDate()](./doc/api/api.md#EndOfMixed#endOfDate)
  - [#endOfDay()](./doc/api/api.md#EndOfMixed#endOfDay)
  - [#endOfHour()](./doc/api/api.md#EndOfMixed#endOfHour)
  - [#endOfIsoWeek()](./doc/api/api.md#EndOfMixed#endOfIsoWeek)
  - [#endOfMinute()](./doc/api/api.md#EndOfMixed#endOfMinute)
  - [#endOfMonth()](./doc/api/api.md#EndOfMixed#endOfMonth)
  - [#endOfQuarter()](./doc/api/api.md#EndOfMixed#endOfQuarter)
  - [#endOfSecond()](./doc/api/api.md#EndOfMixed#endOfSecond)
  - [#endOfWeek()](./doc/api/api.md#EndOfMixed#endOfWeek)
  - [#endOfYear()](./doc/api/api.md#EndOfMixed#endOfYear)
- GetMixed
  - [#get(unit)](./doc/api/api.md#GetMixed#get)
  - [#getDate()](./doc/api/api.md#GetMixed#getDate)
  - [#getHour()](./doc/api/api.md#GetMixed#getHour)
  - [#getMillisecond()](./doc/api/api.md#GetMixed#getMillisecond)
  - [#getMinute()](./doc/api/api.md#GetMixed#getMinute)
  - [#getMonth()](./doc/api/api.md#GetMixed#getMonth)
  - [#getSecond()](./doc/api/api.md#GetMixed#getSecond)
  - [#getYear()](./doc/api/api.md#GetMixed#getYear)
- module:@the-/date
  - [.create(args)](./doc/api/api.md#module_@the-/date.create)
  - [.default()](./doc/api/api.md#module_@the-/date.default)
  - [.Durations](./doc/api/api.md#module_@the-/date.Durations)
  - [.mixins](./doc/api/api.md#module_@the-/date.mixins)
  - [.TheDate](./doc/api/api.md#module_@the-/date.TheDate)
  - [.TheDateBase](./doc/api/api.md#module_@the-/date.TheDateBase)
  - [.units](./doc/api/api.md#module_@the-/date.units)
- module:@the-/date.mixins
  - [.addMix(Class)](./doc/api/api.md#module_@the-/date.mixins.addMix)
  - [.endOf(Class)](./doc/api/api.md#module_@the-/date.mixins.endOf)
  - [.getMix(Class)](./doc/api/api.md#module_@the-/date.mixins.getMix)
  - [.momentMix(Class)](./doc/api/api.md#module_@the-/date.mixins.momentMix)
  - [.setMix(Class)](./doc/api/api.md#module_@the-/date.mixins.setMix)
  - [.startOf(Class)](./doc/api/api.md#module_@the-/date.mixins.startOf)
  - [.subtractMix(Class)](./doc/api/api.md#module_@the-/date.mixins.subtractMix)
- module:@the-/date.mixins.addMix
  - [~AddMixed](./doc/api/api.md#module_@the-/date.mixins.addMix~AddMixed)
- module:@the-/date.mixins.endOf
  - [~EndOfMixed](./doc/api/api.md#module_@the-/date.mixins.endOf~EndOfMixed)
- module:@the-/date.mixins.getMix
  - [~GetMixed](./doc/api/api.md#module_@the-/date.mixins.getMix~GetMixed)
- module:@the-/date.mixins.momentMix
  - [~MomentMixed](./doc/api/api.md#module_@the-/date.mixins.momentMix~MomentMixed)
- module:@the-/date.mixins.setMix
  - [~SetMixed](./doc/api/api.md#module_@the-/date.mixins.setMix~SetMixed)
- module:@the-/date.mixins.startOfMix
  - [~StartOfMixed](./doc/api/api.md#module_@the-/date.mixins.startOfMix~StartOfMixed)
- module:@the-/date.mixins.subtractMix
  - [~SubtractMixed](./doc/api/api.md#module_@the-/date.mixins.subtractMix~SubtractMixed)
- MomentMixed
  - [#toMoment()](./doc/api/api.md#MomentMixed#toMoment)
- SetMixed
  - [#set(key,value)](./doc/api/api.md#SetMixed#set)
  - [#setDate(value)](./doc/api/api.md#SetMixed#setDate)
  - [#setHour(value)](./doc/api/api.md#SetMixed#setHour)
  - [#setMillisecond(value)](./doc/api/api.md#SetMixed#setMillisecond)
  - [#setMinute(value)](./doc/api/api.md#SetMixed#setMinute)
  - [#setMonth(value)](./doc/api/api.md#SetMixed#setMonth)
  - [#setSecond(value)](./doc/api/api.md#SetMixed#setSecond)
  - [#setYear(value)](./doc/api/api.md#SetMixed#setYear)
- StartOfMixed
  - [#startOf(unit)](./doc/api/api.md#StartOfMixed#startOf)
  - [#startOfDate()](./doc/api/api.md#StartOfMixed#startOfDate)
  - [#startOfDay()](./doc/api/api.md#StartOfMixed#startOfDay)
  - [#startOfHour()](./doc/api/api.md#StartOfMixed#startOfHour)
  - [#startOfIsoWeek()](./doc/api/api.md#StartOfMixed#startOfIsoWeek)
  - [#startOfMinute()](./doc/api/api.md#StartOfMixed#startOfMinute)
  - [#startOfMonth()](./doc/api/api.md#StartOfMixed#startOfMonth)
  - [#startOfQuarter()](./doc/api/api.md#StartOfMixed#startOfQuarter)
  - [#startOfSecond()](./doc/api/api.md#StartOfMixed#startOfSecond)
  - [#startOfWeek()](./doc/api/api.md#StartOfMixed#startOfWeek)
  - [#startOfYear()](./doc/api/api.md#StartOfMixed#startOfYear)
- SubtractMixed
  - [#subtract(amount,unit)](./doc/api/api.md#SubtractMixed#subtract)
  - [#subtractDay(day)](./doc/api/api.md#SubtractMixed#subtractDay)
  - [#subtractDays(days)](./doc/api/api.md#SubtractMixed#subtractDays)
  - [#subtractHour(hour)](./doc/api/api.md#SubtractMixed#subtractHour)
  - [#subtractHours(hours)](./doc/api/api.md#SubtractMixed#subtractHours)
  - [#subtractMillisecond(millisecond)](./doc/api/api.md#SubtractMixed#subtractMillisecond)
  - [#subtractMilliseconds(milliseconds)](./doc/api/api.md#SubtractMixed#subtractMilliseconds)
  - [#subtractMinute(minute)](./doc/api/api.md#SubtractMixed#subtractMinute)
  - [#subtractMinutes(minutes)](./doc/api/api.md#SubtractMixed#subtractMinutes)
  - [#subtractMonth(month)](./doc/api/api.md#SubtractMixed#subtractMonth)
  - [#subtractMonths(months)](./doc/api/api.md#SubtractMixed#subtractMonths)
  - [#subtractQuarter(quarter)](./doc/api/api.md#SubtractMixed#subtractQuarter)
  - [#subtractQuarters(quarters)](./doc/api/api.md#SubtractMixed#subtractQuarters)
  - [#subtractSecond(second)](./doc/api/api.md#SubtractMixed#subtractSecond)
  - [#subtractSeconds(seconds)](./doc/api/api.md#SubtractMixed#subtractSeconds)
  - [#subtractWeek(week)](./doc/api/api.md#SubtractMixed#subtractWeek)
  - [#subtractWeeks(weeks)](./doc/api/api.md#SubtractMixed#subtractWeeks)
  - [#subtractYear(year)](./doc/api/api.md#SubtractMixed#subtractYear)
  - [#subtractYears(years)](./doc/api/api.md#SubtractMixed#subtractYears)
- TheDate
  - [#format(format)](./doc/api/api.md#TheDate#format)
  - [#fromNow()](./doc/api/api.md#TheDate#fromNow)
  - [#toDate()](./doc/api/api.md#TheDate#toDate)
  - [#toJSON()](./doc/api/api.md#TheDate#toJSON)
  - [#toNumber()](./doc/api/api.md#TheDate#toNumber)
  - [#toString()](./doc/api/api.md#TheDate#toString)

See [API Guide](./doc/api/api.md) for more detail


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/the-labo/the/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [THE Labo][the_labo_url]

[the_labo_url]: https://github.com/the-labo

<!-- Links End -->