onday

Returns a random sentence about a historical event that happened on the given date ( day and month ).

Install

$ npm install --save onday

Usage

The Class Constructor accepts two numeric values: day and month For example:

let findOnThisDate = new onday(25, 12); //Christmas Day

Calling the method check() returns a Promise with the contents.

Each call to the check() method will return different content for the given date.

You can also pass a date argument: (day,month) to the check() method. For example: findOnThisDate.check(1,1) //Change to 1st January

API

Here we cover the most 'useful' methods

check([number, number[,true]])

Use this method to retrieve information for a given date, by passing (numeric day value, numeric month value). The third argument is a boolean and is only required if to retrieve mock text - this is here for testing purposes only, and will return text without connecting to the internet.

If no values are passed then the current date (day, month) will be used automatically.

Syntax

onday.check(15, 10); //15 October

Parameters

Optional     day value         [numeric]

Optional     month value     [number]

If not given, then the Class instance's constructor properties (day,month) values are used instead.

Returns

A Promise containing a sentence, about a historical event from the date parameters, or if not given then the Class instance properties.

Example 1

Using then().catch()

const onday = require("onday");

const day = 8;
const month = 10; //October

let randomDate = new onday(day, month);

randomDate1
  .check()
  .then((info) => {
    console.log(`on ${day}/${month} this happened: ${info}`);
  })
  .catch((error) => {
    console.error(`Error ${error}`);
  });

example Output

on 8/10 this happened: October 8th is the day in 1962 that Algeria joins the United Nations.

Example 2

Using an async / await function.

const onday = require("onday");

const fn = async () => {
  let contents = await new onday(25, 12).check();
  console.log(`contents: ${contents}`);
};
fn();
fn(); //can be called multiple times!

Example Output

contents: December 25th is the day in 1974 that Cyclone Tracy devastates Darwin, Northern Territory Australia.
contents: December 25th is the day in 1826 that the Eggnog Riot at the United States Military Academy concludes after beginning the previous evening.

getdate([number, number])

Use this method to retrieve a formatted return date. Pass optional parameters (numeric day value, numeric month value) to get the formatted date.

If no values are passed then the default current date (day, month) will be used automatically.

Errorhandling will return a rejected promise.

Syntax

onday.getdate(15, 10); // returns: '15th Oct'

Parameters

Optional     day value         [numeric]

Optional     month value     [number]

If not given, then the Class instance's constructor properties (day,month) values are used instead.

Returns

A Promise containing the formatted date as a String.

Example

Using then().catch()

const onday = require("onday");

const myDate = new onday();
myDate
  .getdate(8, 10)
  .then((val) => {
    console.log(`getdate = ${val}`);
  })
  .catch((e) => {
    console.error(`problem with the date: ${e}`);
  });

Example Output

getdate = 8th Oct