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,
;
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
// => 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
// => 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 iffmt
is not defined.- return {Array} Weekday list between given dates
Example
// => [// 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 iffmt
is not defined.- return {Array} Recent weekday list
Example
// => [// 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
// => 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 iffmt
is not defined.- return {Number} The cound
Example
// => [// 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
// => 2018/06/20
License
Copyright © 2018, ZiQiangWang. Released under the MIT License.