Skip to content

Commit

Permalink
Rename formatAsZonedTime to formatInTimeZone
Browse files Browse the repository at this point in the history
  • Loading branch information
marnusw committed Dec 20, 2021
1 parent 5eef1ec commit 618a0a0
Show file tree
Hide file tree
Showing 18 changed files with 96 additions and 96 deletions.
4 changes: 2 additions & 2 deletions src/esm/fp/index.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
// This file is generated automatically by `scripts/build/indices.js`. Please, don't change it.

export { default as format } from './format/index.js'
export { default as formatAsZonedTime } from './formatAsZonedTime/index.js'
export { default as formatAsZonedTimeWithOptions } from './formatAsZonedTimeWithOptions/index.js'
export { default as formatInTimeZone } from './formatInTimeZone/index.js'
export { default as formatInTimeZoneWithOptions } from './formatInTimeZoneWithOptions/index.js'
export { default as formatWithOptions } from './formatWithOptions/index.js'
export { default as getTimezoneOffset } from './getTimezoneOffset/index.js'
export { default as toDate } from './toDate/index.js'
Expand Down
2 changes: 1 addition & 1 deletion src/esm/index.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// This file is generated automatically by `scripts/build/indices.js`. Please, don't change it.

export { default as format } from './format/index.js'
export { default as formatAsZonedTime } from './formatAsZonedTime/index.js'
export { default as formatInTimeZone } from './formatInTimeZone/index.js'
export { default as getTimezoneOffset } from './getTimezoneOffset/index.js'
export { default as toDate } from './toDate/index.js'
export { default as utcToZonedTime } from './utcToZonedTime/index.js'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// This file is generated automatically by `scripts/build/typings.js`. Please, don't change it.

import { formatAsZonedTime } from 'date-fns-tz'
export = formatAsZonedTime
import { formatInTimeZone } from 'date-fns-tz'
export = formatInTimeZone
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import format from '../format'
import utcToZonedTime from '../utcToZonedTime'

/**
* @name formatAsZonedTime
* @name formatInTimeZone
* @category Time Zone Helpers
* @summary Gets the offset in milliseconds between the time zone and Universal Coordinated Time (UTC)
*
Expand All @@ -23,7 +23,7 @@ import utcToZonedTime from '../utcToZonedTime'
* @param {String} [options.timeZone=''] - used to specify the IANA time zone offset of a date String.
* @returns {String} the formatted date string
*/
export default function formatAsZonedTime(date, timeZone, formatStr, options) {
export default function formatInTimeZone(date, timeZone, formatStr, options) {
var extendedOptions = cloneObject(options)
extendedOptions.timeZone = timeZone
return format(utcToZonedTime(date, timeZone), formatStr, extendedOptions)
Expand Down
File renamed without changes.
10 changes: 5 additions & 5 deletions src/formatAsZonedTime/test.js → src/formatInTimeZone/test.js
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
import assert from 'power-assert'
import formatAsZonedTime from './index'
import formatInTimeZone from './index'

describe('formatAsZonedTime', function () {
describe('formatInTimeZone', function () {
it('shifts the date to the zoned time and formats', function () {
var date = '1986-04-04T10:32:55.123Z'
var timeZone = 'Europe/Paris'
var result = formatAsZonedTime(date, timeZone, "dd.MM.yyyy HH:mm 'UTC'xxx")
var result = formatInTimeZone(date, timeZone, "dd.MM.yyyy HH:mm 'UTC'xxx")
assert(result === '04.04.1986 12:32 UTC+02:00')
})

it('throws a RangeError on invalid time zones', function () {
var date = '1986-04-04T10:32:55.123Z'
assert.throws(
formatAsZonedTime.bind(null, date, '02:65', "dd.MM.yyyy HH:mm 'UTC'xxx"),
formatInTimeZone.bind(null, date, '02:65', "dd.MM.yyyy HH:mm 'UTC'xxx"),
RangeError
)
assert.throws(
formatAsZonedTime.bind(null, date, 'bad/timezone', "dd.MM.yyyy HH:mm 'UTC'xxx"),
formatInTimeZone.bind(null, date, 'bad/timezone', "dd.MM.yyyy HH:mm 'UTC'xxx"),
RangeError
)
})
Expand Down
4 changes: 0 additions & 4 deletions src/fp/formatAsZonedTimeWithOptions/index.d.ts

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// This file is generated automatically by `scripts/build/typings.js`. Please, don't change it.

import { formatAsZonedTime } from 'date-fns-tz/fp'
export = formatAsZonedTime
import { formatInTimeZone } from 'date-fns-tz/fp'
export = formatInTimeZone
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
// This file is generated automatically by `scripts/build/fp.js`. Please, don't change it.

import fn from '../../formatAsZonedTime/index.js'
import fn from '../../formatInTimeZone/index.js'
import convertToFP from 'date-fns/fp/_lib/convertToFP/index.js'

var formatAsZonedTime = convertToFP(fn, 2)
var formatInTimeZone = convertToFP(fn, 2)

export default formatAsZonedTime
export default formatInTimeZone
File renamed without changes.
4 changes: 4 additions & 0 deletions src/fp/formatInTimeZoneWithOptions/index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
// This file is generated automatically by `scripts/build/typings.js`. Please, don't change it.

import { formatInTimeZoneWithOptions } from 'date-fns-tz/fp'
export = formatInTimeZoneWithOptions
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
// This file is generated automatically by `scripts/build/fp.js`. Please, don't change it.

import fn from '../../formatAsZonedTime/index.js'
import fn from '../../formatInTimeZone/index.js'
import convertToFP from 'date-fns/fp/_lib/convertToFP/index.js'

var formatAsZonedTimeWithOptions = convertToFP(fn, 3)
var formatInTimeZoneWithOptions = convertToFP(fn, 3)

export default formatAsZonedTimeWithOptions
export default formatInTimeZoneWithOptions
4 changes: 2 additions & 2 deletions src/fp/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

module.exports = {
format: require('./format/index.js'),
formatAsZonedTime: require('./formatAsZonedTime/index.js'),
formatAsZonedTimeWithOptions: require('./formatAsZonedTimeWithOptions/index.js'),
formatInTimeZone: require('./formatInTimeZone/index.js'),
formatInTimeZoneWithOptions: require('./formatInTimeZoneWithOptions/index.js'),
formatWithOptions: require('./formatWithOptions/index.js'),
getTimezoneOffset: require('./getTimezoneOffset/index.js'),
toDate: require('./toDate/index.js'),
Expand Down
4 changes: 2 additions & 2 deletions src/fp/index.js.flow
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ type CurriedFn4<A, B, C, D, R> = <A>(

declare module.exports: {
format: CurriedFn2<string, Date | string | number, string>,
formatAsZonedTime: CurriedFn2<string, Date | number, string>,
formatAsZonedTimeWithOptions: CurriedFn3<OptionsWithTZ, string, Date | number, string>,
formatInTimeZone: CurriedFn2<string, Date | number, string>,
formatInTimeZoneWithOptions: CurriedFn3<OptionsWithTZ, string, Date | number, string>,
formatWithOptions: CurriedFn3<OptionsWithTZ, string, Date | string | number, string>,
getTimezoneOffset: CurriedFn2<Date | number, string, number>,
toDate: CurriedFn1<Date | string | number, Date>,
Expand Down
2 changes: 1 addition & 1 deletion src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

module.exports = {
format: require('./format/index.js'),
formatAsZonedTime: require('./formatAsZonedTime/index.js'),
formatInTimeZone: require('./formatInTimeZone/index.js'),
getTimezoneOffset: require('./getTimezoneOffset/index.js'),
toDate: require('./toDate/index.js'),
utcToZonedTime: require('./utcToZonedTime/index.js'),
Expand Down
2 changes: 1 addition & 1 deletion src/index.js.flow
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ type OptionsWithTZ = {
declare module.exports: {
format: (date: Date | string | number, format: string, options?: OptionsWithTZ) => string,

formatAsZonedTime: (date: Date | number, timeZone: string, options?: OptionsWithTZ) => string,
formatInTimeZone: (date: Date | number, timeZone: string, options?: OptionsWithTZ) => string,

getTimezoneOffset: (timeZone: string, date?: Date | number) => number,

Expand Down
Loading

0 comments on commit 618a0a0

Please sign in to comment.