Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 1.5 KB

README.md

File metadata and controls

62 lines (40 loc) · 1.5 KB
Raw

A library to parse time ranges

Installing

npm install github:FullstackAcademy/time-ranges#v-1.0.7 (or the version you want)

Tests Are Passing

The module index.ts exports two functions:

generateTimeRanges

Generate time ranges accepts two arguments, a timeString and a moment object that will be used as the calendar date of the time ranges. (Defaults to moment())

generateTimeRanges returns [MomentRange], specified as:

type MomentRange = {
  start: moment.Moment,
  end: moment.Moment
}

inspectTimeString

Useful for inspecting the output of a timeString. Will print a human readable output of a generated set of ranges.

example:

inspectTimeString('9:00am-10:00am, 12:00pm-5:30pm')

Will print:

========================
timeString:
9:00am-10:00am, 12:00pm-5:30pm

From: April 29, 2020 9:00 AM
  To: April 29, 2020 10:00 AM

From: April 29, 2020 12:00 PM
  To: April 29, 2020 5:30 PM

Releasing

time-ranges is currently released through git tags.

Once you wish to cut a new release from the master branch follow these steps:

  1. Determine the next appropriate version tag.
  2. Checkout master locally.
  3. Run script/release v-x.y.z (replacing x.y.z with version numbers)

The release script will build js sources and type definitions and push them up to github as a tag.

Then npm install github:FullstackAcademy/time-ranges#v-x.y.z