is-birthday v1.0.2

is-birthday

given birthdate checks if today is a birthday

is-birthday takes in a date formatted as a string and returns true if it is a birthday on that date.

Install

$ npm install is-birthday

Usage

const isBirthday = require('is-birthday');

// If today is 2020-05-07
isBirthday("1999-05-07") // => true
isBirthday("1999-02-06") // => false

// Set a different "today"
const options = {today: new Date("2020-05-06")}
isBirthday("1999-05-06",  options) // => true

API

isBirthday(birthdate, options)

Returns true or false depending on whether it is a birthday given a birthdate.

birthdate

Type: string

Date, as a string, to check whether it's a birthday or not. Gets converted to a Date object.

options

Type: object

today

Type: Date Default: new Date()

Date to compare birthdate with.

License

MIT © Jan Meppe