└── README.md


/README.md:
--------------------------------------------------------------------------------
  1 | # bizhours.js 
  2 | 
  3 | bizhours.js is a lightweight javascript library for parsing storing, displaying and querying
  4 | a business' open hours.  It's developed and maintained at Zendesk for the link-sf.org project.
  5 | 
  6 | ## howto use
  7 | 
  8 |      > var h = new BizHours({sun: "9am-7pm", mon: "10am-7pm", wed: "4am-5am", thu: "4am-5am"})
  9 |      > h.humanize().forEach(function(day) { 
 10 |           console.log(day.day); 
 11 |           console.log(day.hours) 
 12 |        });
 13 | 
 14 |        Sunday
 15 |        9am - 7pm
 16 |        Monday
 17 |        10am - 7pm
 18 |        Tuesday
 19 |        null
 20 |        Wednesday
 21 |        4am - 5am
 22 |        Thursday
 23 |        4am - 5am
 24 |        Friday
 25 |        null
 26 |        Saturday
 27 |        null
 28 |     
 29 |      > h.humanizeCondensed().forEach(function(range) {
 30 |           console.log(range.day);
 31 |           console.log(range.hours)
 32 |        });
 33 | 
 34 |        Sunday
 35 |        9am - 7pm
 36 |        Monday
 37 |        10am - 7pm
 38 |        Wednesday - Thursday
 39 |        4am - 5am
 40 | 
 41 | ## more:
 42 | 
 43 | <p>
 44 | <b>constructor</b>
 45 | <code>new BizHours(hoursObject)</code>
 46 | <br/>
 47 | Creates a new BizHours object from hoursObject input.  hoursObject is a javascript obj with keys of ["mon", "tue", "wed", "thu", "fri", "sat", "sun"], and values
 48 | of the following format: "9am-1pm, 1:30pm - 5:30pm".
 49 |     var h = new BizHours({mon: "9am - 1pm", tue: "11am - 3pm"})
 50 | <p>
 51 | <b>addDay</b>
 52 | <code>.addDay(dayName, timeString)</code>
 53 | <br/>
 54 | Sets dayName's open hours to the parsed value of timeString.  The format of dayName and timeString follow the constructor's arguments.
 55 | 
 56 |     h.addDay("mon", "5pm-7pm")
 57 | 
 58 | <p>
 59 | <b>merge</b>
 60 | <code>.merge(hoursObject)</code>
 61 | <br/>
 62 | Merge hoursObject (a bizHours object) into this object.
 63 | 
 64 |     h.merge(other)
 65 | 
 66 | <p>
 67 | <b>humanize</b>
 68 | <code>.humanize()</code>
 69 | <br/>
 70 | Return an array objects representing open hours
 71 | 
 72 |     > h.humanize()
 73 |     [
 74 |       {day: "Monday", 
 75 |        hours: "9am-5pm"},
 76 |       {day: "Tuesday", 
 77 |        hours: "9am-5pm"},
 78 |       ...
 79 |     ]
 80 | 
 81 | <p>
 82 | <b>humanizeCondensed</b>
 83 | <code>.humanizeCondensed()</code>
 84 | <br/>
 85 | The same as .humanize, but with runs of days that have the same hours collapsed into one array entry:
 86 | 
 87 |     > h.humanizeCondensed()
 88 |     [
 89 |       {day: "Monday - Tuesday", 
 90 |        hours: "9am-5pm"},
 91 |       {day: "Wednesday", 
 92 |        hours: "11am-5pm"},
 93 |       ...
 94 |     ]
 95 | <p>
 96 | <b>within</b>
 97 | <code>.within(date)</code>
 98 | <br/>
 99 | Returns whether the given date is within the business' open hours (assuming that the date and biz hours are within the same timezone).
100 | 
101 | 
102 | 
103 | 
104 | 


--------------------------------------------------------------------------------