weekday.js

A tiny library for weekday, you can get weekday list and format it easily.Such as get all weekdays recently, weekdays within a period of time, weekdays counts...

Install

npm i weekdayjs

Usage

Import the whole library, ~4kb bundle size.

import { rangeCount } from 'weekdayjs';

or use the function as you need,

import rangeCount from 'weekdayjs/lib/rangeCount';

API

isWeekday

Check if the given date fall on a weekday.

Params

• date {Date}: The date to be checked.
• return {Boolean} The date is weekday

Example

isWeekday(new Date(2018, 5, 20))
// => true

rangeCount

Get weekday count between two dates.

Params

• start {Date}: The start date.
• end {Date}: The end date.
• return {Number} The count between start and end

Example

rangeCount(new Date(2018, 5, 20), new Date(2018, 5, 30))
// => 8

rangeWeekdays

Get weekday list between given dates.

Params

• start {Date}: The start date.
• end {Date}: The end date.
• fmt {String}: Result format, return Date type if fmt is not defined.
• return {Array} Weekday list between given dates

Example

rangeWeekdays(new Date(2018, 5, 20), new Date(2018, 5, 25))
// => [
//        new Date(2018, 5, 20),
//        new Date(2018, 5, 21),
//        new Date(2018, 5, 22),
//        new Date(2018, 5, 25),
//    ]

recentWeekdays

Get a certain amount of weekdays from given date.

Params

• days {Number}: Weekday count.
• origin {Date}: The original date, default today.
• fmt {String}: Result format, return Date type if fmt is not defined.
• return {Array} Recent weekday list

Example

recentWeekdays(3, new Date(2018, 5, 20))
// => [
//        new Date(2018, 5, 20),
//        new Date(2018, 5, 21),
//        new Date(2018, 5, 22),
//    ]

distanceCount

Get the number of weekday in the range of n days from given date.

Params

• offset {Number}: Days from original date.
• origin {Date}: The original date, default today.
• return {Number} The cound

Example

distanceCount(10, new Date(2018, 5, 20))
// => 8

distanceWeekdays

Get the weekday list in the range of n days from given date.

Params

• offset {Number}: Days from original date.
• origin {Date}: The original date, default today.
• fmt {String}: Result format, return Date type if fmt is not defined.
• return {Number} The cound

Example

distanceWeekdays(5, new Date(2018, 5, 25))
// => [
//       new Date(2018, 5, 20),
//       new Date(2018, 5, 21),
//       new Date(2018, 5, 22),
//       new Date(2018, 5, 25),
//    ]

format

Format date to given mask.

Params

• date {Date}: Date to format.
• maks {String}: Format mask.
• utc {Boolean}: Use utc or not.
• return {String} Formated date.

Example

format(new Date(2018, 5, 20), 'yyyy/mm/dd')
// => 2018/06/20

License

Copyright © 2018, ZiQiangWang. Released under the MIT License.