summaryrefslogtreecommitdiff
path: root/date-fns/src/addMonths/test.ts
blob: fb1afb6991e96aae1ac664f2652483a347733cbb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
// @flow
/* eslint-env mocha */

import assert from 'assert'
import addMonths from '.'
import { getDstTransitions } from '../../test/dst/tzOffsetTransitions'

describe('addMonths', function() {
  it('adds the given number of months', function() {
    const result = addMonths(new Date(2014, 8 /* Sep */, 1), 5)
    assert.deepStrictEqual(result, new Date(2015, 1 /* Feb */, 1))
  })

  it('accepts a timestamp', function() {
    const result = addMonths(new Date(2014, 8 /* Sep */, 1).getTime(), 12)
    assert.deepStrictEqual(result, new Date(2015, 8 /* Sep */, 1))
  })

  it('converts a fractional number to an integer', function() {
    const result = addMonths(new Date(2014, 8 /* Sep */, 1), 5.75)
    assert.deepStrictEqual(result, new Date(2015, 1 /* Feb */, 1))
  })

  it('implicitly converts number arguments', function() {
    // @ts-expect-error
    const result = addMonths(new Date(2014, 8 /* Sep */, 1), '5')
    assert.deepStrictEqual(result, new Date(2015, 1 /* Feb */, 1))
  })

  it('does not mutate the original date', function() {
    const date = new Date(2014, 8 /* Sep */, 1)
    addMonths(date, 12)
    assert.deepStrictEqual(date, new Date(2014, 8 /* Sep */, 1))
  })

  it('works well if the desired month has fewer days and the provided date is in the last day of a month', function() {
    const date = new Date(2014, 11 /* Dec */, 31)
    const result = addMonths(date, 2)
    assert.deepStrictEqual(result, new Date(2015, 1 /* Feb */, 28))
  })

  it('handles dates before 100 AD', function() {
    const initialDate = new Date(0)
    initialDate.setFullYear(0, 0 /* Jan */, 31)
    initialDate.setHours(0, 0, 0, 0)
    const expectedResult = new Date(0)
    expectedResult.setFullYear(0, 1 /* Feb */, 29)
    expectedResult.setHours(0, 0, 0, 0)
    const result = addMonths(initialDate, 1)
    assert.deepStrictEqual(result, expectedResult)
  })

  it('returns `Invalid Date` if the given date is invalid', function() {
    const result = addMonths(new Date(NaN), 5)
    // @ts-expect-error
    assert(result instanceof Date && isNaN(result))
  })

  it('returns `Invalid Date` if the given amount is NaN', function() {
    const result = addMonths(new Date(2014, 8 /* Sep */, 1), NaN)
    // @ts-expect-error
    assert(result instanceof Date && isNaN(result))
  })

  it('throws TypeError exception if passed less than 2 arguments', function() {
    // @ts-expect-error
    assert.throws(addMonths.bind(null), TypeError)
    // @ts-expect-error
    assert.throws(addMonths.bind(null, 1), TypeError)
  })

  const dstTransitions = getDstTransitions(2017)
  const dstOnly = dstTransitions.start && dstTransitions.end ? it : it.skip
  const tz = Intl.DateTimeFormat().resolvedOptions().timeZone || process.env.tz
  const HOUR = 1000 * 60 * 60
  const override = (
    base: Date,
    year = base.getFullYear(),
    month = base.getMonth(),
    day = base.getDate(),
    hour = base.getHours(),
    minute = base.getMinutes()
  ) => new Date(year, month, day, hour, minute)

  dstOnly(
    `works at DST-start boundary in local timezone: ${tz || '(unknown)'}`,
    function() {
      const date = dstTransitions.start
      const result = addMonths(date!, 2)
      assert.deepStrictEqual(
        result,
        override(date!, date!.getFullYear(), date!.getMonth() + 2)
      )
    }
  )

  dstOnly(
    `works at DST-start - 30 mins in local timezone: ${tz || '(unknown)'}`,
    function() {
      const date = new Date(dstTransitions.start!.getTime() - 0.5 * HOUR)
      const result = addMonths(date, 2)
      const expected = override(date, date.getFullYear(), date.getMonth() + 2)
      assert.deepStrictEqual(result, expected)
    }
  )

  dstOnly(
    `works at DST-start - 60 mins in local timezone: ${tz || '(unknown)'}`,
    function() {
      const date = new Date(dstTransitions.start!.getTime() - 1 * HOUR)
      const result = addMonths(date, 2)
      const expected = override(date, date.getFullYear(), date.getMonth() + 2)
      assert.deepStrictEqual(result, expected)
    }
  )

  dstOnly(
    `works at DST-end boundary in local timezone: ${tz || '(unknown)'}`,
    function() {
      const date = dstTransitions.end
      const result = addMonths(date!, 2)
      assert.deepStrictEqual(
        result,
        override(
          date!,
          date!.getFullYear() + (date!.getMonth() >= 10 ? 1 : 0),
          (date!.getMonth() + 2) % 12 // protect against wrap for Nov.
        )
      )
    }
  )

  dstOnly(
    `works at DST-end - 30 mins in local timezone: ${tz || '(unknown)'}`,
    function() {
      const date = new Date(dstTransitions.end!.getTime() - 0.5 * HOUR)
      const result = addMonths(date, 2)
      assert.deepStrictEqual(
        result,
        override(
          date,
          date.getFullYear() + (date.getMonth() >= 10 ? 1 : 0),
          (date.getMonth() + 2) % 12 // protect against wrap for Nov.
        )
      )
    }
  )

  dstOnly(
    `works at DST-end - 60 mins in local timezone: ${tz || '(unknown)'}`,
    function() {
      const date = new Date(dstTransitions.end!.getTime() - 1 * HOUR)
      const result = addMonths(date, 2)
      assert.deepStrictEqual(
        result,
        override(
          date,
          date.getFullYear() + (date.getMonth() >= 10 ? 1 : 0),
          (date.getMonth() + 2) % 12 // protect against wrap for Nov.
        )
      )
    }
  )

  dstOnly(
    `doesn't mutate if zero increment is used: ${tz || '(unknown)'}`,
    function() {
      const date = new Date(dstTransitions.end!)
      const result = addMonths(date, 0)
      assert.deepStrictEqual(result, date)
    }
  )
})