Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: update format types to match date-fns #199

Merged
merged 1 commit into from Jan 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/format/index.js
Expand Up @@ -272,7 +272,7 @@ var tzFormattingTokensRegExp = /([xXOz]+)|''|'(''|[^'])+('|$)/g
*
* - Characters are now escaped using single quote symbols (`'`) instead of square brackets.
*
* @param {Date|String|Number} date - the original date
* @param {Date|Number} date - the original date
* @param {String} format - the string of tokens
* @param {OptionsWithTZ} [options] - the object with options. See [Options]{@link https://date-fns.org/docs/Options}
* @param {0|1|2} [options.additionalDigits=2] - passed to `toDate`. See [toDate]{@link
Expand Down
6 changes: 1 addition & 5 deletions src/format/index.js.flow
Expand Up @@ -16,8 +16,4 @@ type OptionsWithTZ = {
awareOfUnicodeTokens?: boolean,
}

declare module.exports: (
date: Date | string | number,
format: string,
options?: OptionsWithTZ
) => string
declare module.exports: (date: Date | number, format: string, options?: OptionsWithTZ) => string
2 changes: 1 addition & 1 deletion src/fp/format/index.js.flow
Expand Up @@ -20,4 +20,4 @@ type CurriedFn1<A, R> = <A>(a: A) => R

type CurriedFn2<A, B, R> = <A>(a: A) => CurriedFn1<B, R> | (<A, B>(a: A, b: B) => R)

declare module.exports: CurriedFn2<string, Date | string | number, string>
declare module.exports: CurriedFn2<string, Date | number, string>
2 changes: 1 addition & 1 deletion src/fp/formatWithOptions/index.js.flow
Expand Up @@ -26,4 +26,4 @@ type CurriedFn3<A, B, C, R> = <A>(
| CurriedFn2<B, C, R>
| (<A, B>(a: A, b: B) => CurriedFn1<C, R> | (<A, B, C>(a: A, b: B, c: C) => R))

declare module.exports: CurriedFn3<OptionsWithTZ, string, Date | string | number, string>
declare module.exports: CurriedFn3<OptionsWithTZ, string, Date | number, string>
4 changes: 2 additions & 2 deletions src/fp/index.js.flow
Expand Up @@ -42,7 +42,7 @@ type CurriedFn4<A, B, C, D, R> = <A>(
) => CurriedFn1<D, R> | (<A, B, C, D>(a: A, b: B, c: C, d: D) => R)))

declare module.exports: {
format: CurriedFn2<string, Date | string | number, string>,
format: CurriedFn2<string, Date | number, string>,
formatInTimeZone: CurriedFn3<string, string, Date | string | number, string>,
formatInTimeZoneWithOptions: CurriedFn4<
OptionsWithTZ,
Expand All @@ -51,7 +51,7 @@ declare module.exports: {
Date | string | number,
string
>,
formatWithOptions: CurriedFn3<OptionsWithTZ, string, Date | string | number, string>,
formatWithOptions: CurriedFn3<OptionsWithTZ, string, Date | number, string>,
getTimezoneOffset: CurriedFn2<Date | number, string, number>,
toDate: CurriedFn1<Date | string | number, Date>,
toDateWithOptions: CurriedFn2<OptionsWithTZ, Date | string | number, Date>,
Expand Down
2 changes: 1 addition & 1 deletion src/index.js.flow
Expand Up @@ -17,7 +17,7 @@ type OptionsWithTZ = {
}

declare module.exports: {
format: (date: Date | string | number, format: string, options?: OptionsWithTZ) => string,
format: (date: Date | number, format: string, options?: OptionsWithTZ) => string,

formatInTimeZone: (
date: Date | string | number,
Expand Down
12 changes: 6 additions & 6 deletions typings.d.ts
Expand Up @@ -46,7 +46,7 @@ declare module 'date-fns-tz' {
declare module 'date-fns-tz' {
import { OptionsWithTZ } from 'date-fns-tz'

function format(date: Date | string | number, format: string, options?: OptionsWithTZ): string
function format(date: Date | number, format: string, options?: OptionsWithTZ): string
namespace format {}

function formatInTimeZone(
Expand Down Expand Up @@ -173,7 +173,7 @@ declare module 'date-fns-tz/zonedTimeToUtc/index.js' {
declare module 'date-fns-tz/fp' {
import { OptionsWithTZ } from 'date-fns-tz'

const format: CurriedFn2<string, Date | string | number, string>
const format: CurriedFn2<string, Date | number, string>
namespace format {}

const formatInTimeZone: CurriedFn3<string, string, Date | string | number, string>
Expand All @@ -188,7 +188,7 @@ declare module 'date-fns-tz/fp' {
>
namespace formatInTimeZoneWithOptions {}

const formatWithOptions: CurriedFn3<OptionsWithTZ, string, Date | string | number, string>
const formatWithOptions: CurriedFn3<OptionsWithTZ, string, Date | number, string>
namespace formatWithOptions {}

const getTimezoneOffset: CurriedFn2<Date | number, string, number>
Expand Down Expand Up @@ -383,7 +383,7 @@ declare module 'date-fns-tz/fp/zonedTimeToUtcWithOptions/index.js' {
declare module 'date-fns-tz/esm' {
import { OptionsWithTZ } from 'date-fns-tz'

function format(date: Date | string | number, format: string, options?: OptionsWithTZ): string
function format(date: Date | number, format: string, options?: OptionsWithTZ): string
namespace format {}

function formatInTimeZone(
Expand Down Expand Up @@ -510,7 +510,7 @@ declare module 'date-fns-tz/esm/zonedTimeToUtc/index.js' {
declare module 'date-fns-tz/esm/fp' {
import { OptionsWithTZ } from 'date-fns-tz'

const format: CurriedFn2<string, Date | string | number, string>
const format: CurriedFn2<string, Date | number, string>
namespace format {}

const formatInTimeZone: CurriedFn3<string, string, Date | string | number, string>
Expand All @@ -525,7 +525,7 @@ declare module 'date-fns-tz/esm/fp' {
>
namespace formatInTimeZoneWithOptions {}

const formatWithOptions: CurriedFn3<OptionsWithTZ, string, Date | string | number, string>
const formatWithOptions: CurriedFn3<OptionsWithTZ, string, Date | number, string>
namespace formatWithOptions {}

const getTimezoneOffset: CurriedFn2<Date | number, string, number>
Expand Down