random-weekday v1.0.1

random-weekday

Generate a random weekday.

Install

$ npm install --save random-weekday 

Usage

var randomWeekday = require('random-weekday');
  
// API
// - randomWeekday([options]);
  
// options
// - workaday
// - raw
// - min
// - max

By default, returns just the weekday number from 1 to 7:

randomWeekday();
// => 5

Optionally specify raw to get the whole weekday object:

randomWeekday({ raw: true });
// => { name: 'Tuesday', short: 'TUE', number: 2 }

Optionally specify min, max, or both to limit the range.

randomWeekday({ min: 2 });
// => 4

randomWeekday({ max: 5 });
// => 3

randomWeekday({ min: 2, max: 5 });
// => 5

Related

• random-year - Generate a random year.
• random-month - Generate a random month.
• random-day - Generate a random day of a month.
• random-hour - Generate a random hour.
• random-minute - Generate a random minute.
• random-second - Generate a random second.
• random-millisecond - Generate a random millisecond.
• random-datetime - Generate a random date.
• random-ampm - Return am or pm. Very simple.
• random-timestamps - Generate a timestamp.

• random-hammertime - Generate a random hammertime.

Contributing

Pull requests and stars are highly welcome.

For bugs and feature requests, please create an issue.