diff options
author | Sebastian <sebasjm@gmail.com> | 2021-08-23 16:46:06 -0300 |
---|---|---|
committer | Sebastian <sebasjm@gmail.com> | 2021-08-23 16:48:30 -0300 |
commit | 38acabfa6089ab8ac469c12b5f55022fb96935e5 (patch) | |
tree | 453dbf70000cc5e338b06201af1eaca8343f8f73 /date-fns/src/isFriday | |
parent | f26125e039143b92dc0d84e7775f508ab0cdcaa8 (diff) | |
download | node-vendor-38acabfa6089ab8ac469c12b5f55022fb96935e5.tar.gz node-vendor-38acabfa6089ab8ac469c12b5f55022fb96935e5.tar.bz2 node-vendor-38acabfa6089ab8ac469c12b5f55022fb96935e5.zip |
Diffstat (limited to 'date-fns/src/isFriday')
-rw-r--r-- | date-fns/src/isFriday/benchmark.js | 15 | ||||
-rw-r--r-- | date-fns/src/isFriday/index.d.ts | 4 | ||||
-rw-r--r-- | date-fns/src/isFriday/index.js.flow | 52 | ||||
-rw-r--r-- | date-fns/src/isFriday/index.ts | 29 | ||||
-rw-r--r-- | date-fns/src/isFriday/test.ts | 31 |
5 files changed, 131 insertions, 0 deletions
diff --git a/date-fns/src/isFriday/benchmark.js b/date-fns/src/isFriday/benchmark.js new file mode 100644 index 0000000..edeab4d --- /dev/null +++ b/date-fns/src/isFriday/benchmark.js @@ -0,0 +1,15 @@ +// @flow +/* eslint-env mocha */ +/* global suite, benchmark */ + +import isFriday from '.' + +suite('isFriday', function () { + benchmark('date-fns', function () { + return isFriday(this.date) + }) +}, { + setup: function () { + this.date = new Date() + } +}) diff --git a/date-fns/src/isFriday/index.d.ts b/date-fns/src/isFriday/index.d.ts new file mode 100644 index 0000000..17ac2ef --- /dev/null +++ b/date-fns/src/isFriday/index.d.ts @@ -0,0 +1,4 @@ +// This file is generated automatically by `scripts/build/typings.js`. Please, don't change it. + +import { isFriday } from 'date-fns' +export default isFriday diff --git a/date-fns/src/isFriday/index.js.flow b/date-fns/src/isFriday/index.js.flow new file mode 100644 index 0000000..d3f01ee --- /dev/null +++ b/date-fns/src/isFriday/index.js.flow @@ -0,0 +1,52 @@ +// @flow +// This file is generated automatically by `scripts/build/typings.js`. Please, don't change it. + +export type Interval = { + start: Date | number, + end: Date | number, +} + +export type Locale = { + code?: string, + formatDistance?: (...args: Array<any>) => any, + formatRelative?: (...args: Array<any>) => any, + localize?: { + ordinalNumber: (...args: Array<any>) => any, + era: (...args: Array<any>) => any, + quarter: (...args: Array<any>) => any, + month: (...args: Array<any>) => any, + day: (...args: Array<any>) => any, + dayPeriod: (...args: Array<any>) => any, + }, + formatLong?: { + date: (...args: Array<any>) => any, + time: (...args: Array<any>) => any, + dateTime: (...args: Array<any>) => any, + }, + match?: { + ordinalNumber: (...args: Array<any>) => any, + era: (...args: Array<any>) => any, + quarter: (...args: Array<any>) => any, + month: (...args: Array<any>) => any, + day: (...args: Array<any>) => any, + dayPeriod: (...args: Array<any>) => any, + }, + options?: { + weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6, + firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7, + }, +} + +export type Duration = { + years?: number, + months?: number, + weeks?: number, + days?: number, + hours?: number, + minutes?: number, + seconds?: number, +} + +export type Day = 0 | 1 | 2 | 3 | 4 | 5 | 6 + +declare module.exports: (date: Date | number) => boolean diff --git a/date-fns/src/isFriday/index.ts b/date-fns/src/isFriday/index.ts new file mode 100644 index 0000000..9194a2e --- /dev/null +++ b/date-fns/src/isFriday/index.ts @@ -0,0 +1,29 @@ +import toDate from '../toDate/index' +import requiredArgs from '../_lib/requiredArgs/index' + +/** + * @name isFriday + * @category Weekday Helpers + * @summary Is the given date Friday? + * + * @description + * Is the given date Friday? + * + * ### v2.0.0 breaking changes: + * + * - [Changes that are common for the whole library](https://github.com/date-fns/date-fns/blob/master/docs/upgradeGuide.md#Common-Changes). + * + * @param {Date|Number} date - the date to check + * @returns {Boolean} the date is Friday + * @throws {TypeError} 1 argument required + * + * @example + * // Is 26 September 2014 Friday? + * var result = isFriday(new Date(2014, 8, 26)) + * //=> true + */ +export default function isFriday(dirtyDate: Date | number): boolean { + requiredArgs(1, arguments) + + return toDate(dirtyDate).getDay() === 5 +} diff --git a/date-fns/src/isFriday/test.ts b/date-fns/src/isFriday/test.ts new file mode 100644 index 0000000..3eae119 --- /dev/null +++ b/date-fns/src/isFriday/test.ts @@ -0,0 +1,31 @@ +// @flow +/* eslint-env mocha */ + +import assert from 'power-assert' +import isFriday from '.' + +describe('isFriday', function() { + it('returns true if the given date is Friday', function() { + const result = isFriday(new Date(2014, 8 /* Sep */, 26)) + assert(result === true) + }) + + it('returns false if the given date is not Friday', function() { + const result = isFriday(new Date(2014, 8 /* Sep */, 25)) + assert(result === false) + }) + + it('accepts a timestamp', function() { + const result = isFriday(new Date(2014, 1 /* Feb */, 14).getTime()) + assert(result === true) + }) + + it('returns false if the given date is `Invalid Date`', function() { + const result = isFriday(new Date(NaN)) + assert(result === false) + }) + + it('throws TypeError exception if passed less than 1 argument', function() { + assert.throws(isFriday.bind(null), TypeError) + }) +}) |