gyration_crustacean_datelib

DateLib

adds a wrapper for the date object that gives it some useful features

Definition Parameters

D can be defined in every way that a date object can be defined, including leaving it empty to get the current date.

more information about this can be found here

Getters

• D.year
  returns the year based on users location

  d.year // => 2019

• D.month
  returns the month based on the users location

   d.month // => March

• D.monthNum
  returns the Number of the month based on the users location, using 0 indexing, meaning January is month 0
  range is 0 - 11

   d.monthNum // => 2

• D.day
  returns the day of the month based on the users location
  range is 0-30

   d.day // => 23

• D.hour
  returns the hour based on the users location
  range is 0-23

   d.hour // => 9

• D.minute
  returns the minute based on the users location
  range is 0-60

   d.minute // => 34

• D.second
  returns the second based on the users location
  range is 0-60

   d.second // => 12

• D.mili
  returns the milisecond based on the users location
  range is 0-999

   d.mili // => 257

Methods

• D.format(formString)
  The format method returns a formated string to exact specifications
  formString can be any string you like with special characters (listed below) repersenting different parts of the date.
  For example the American standard would be

  myDate.format("M-d-Y") //=> "August-4-2019"

  You can have any seperator you would like as well as any order of characters, and repeat characters.

  myDate.format("M:D:y") //=> "August:04:19"
  myDate.format('Y-M-D h:I:S')) // => 2017-January-02 3:04:05

  formString is optional and if left empty will default to "M D Y"

  The special characters are as listed

  {
  'Y': 2019, // formal year
  'y': 19, // informal year
  'M': "July", // formal month
  'm': "Jul", // informal month
  'D': 01, // formal day
  'd': 1, //informal day
  'H': 05, // formal hour
  'h': 5, // informal hour
  'I': 08, // formal minute
  'i': 8, //informal minute
  'S': 04, // formal second
  's': 4, //informal second
  }

• D.when(relativeTo)
  the when method returns a string repersenting a rough estimate of the time between the D object and the relativeTo object which is also a D.
  relativeTo is optional and if left empty will default to the current date.

  myDate.when() // => "6 months ago"
  aDifferentDate.when() // => "4 months from now"
  b.when() // => "2 days ago"
  c.when() // => "1 year ago"