bTime is a small lightweight library, with no dependencies and 100% test and mutation test coverage, designed to help manage schedules using bit manipulation. It is particularly suited to working with dense schedules with discreet time intervals, e.g. 5 minutes.
- Download the github repository
- run
npm i
to install all the required packages - run
npm build
to build bTime in the/dist
folder
- run
npm i
to install all the required packages - run
npm build
to build bTime in the/dist
folder - run
npm t
to run all tests - run
npm run stryker
to run mutation tests
bTime includes two primary classes, Scheduler and BTimeFactory.
Scheduler instantiates its own BTimeFactory
when instantiated. BTimeFactory
can also be instantiated separately if one desires to directly make use of the btime utils;
// If using the scheduler
// Instantiates a new Scheduler with a time interval of 5 min.
const scheduler: Scheduler = new Scheduler(5);
// To get remaining availability
const remainingAvailabiltiy: string[] = scheduler.getCurrentAvailability(schedule);
// To update a schedule
const updatedSchedule: Schedule = scheduler.updateSchedule(proposedSchedule, currentSchedule);
// To process an appointment
const processedSchedule: Schedule = scheduler.processAppointment(appointment, schedule, ScheduleActions.BOOKING_UPDATE);
// To process an array of appointments
const processedSchedule: Schedule = scheduler.processAppointments(appointments, schedule, ScheduleActions.BOOKING_UPDATE);
// To convert a schedule to an appointment schedule
const processedSchedule: AppointmentSchedule = scheduler.convertScheduleToAppointmentSchedule(schedule);
// If using the factory directly
// Instantiates a new BTimeFactory with a time interval of 5 min.
const bTimeFactory: BTimeFactory = new BTimeFactory(5);
Further information on bTime can be found below:
- Bit Array mode (don't store as strings), optional parameter
- Allow compressed storage mode
- Weeks start on Sunday, this is the same as JS's Date object
- Times are expected to be in UTC, utility converters are provided
- Using 2016 * 2 digits (as a string, once for the schedule, once for bookings) to store the time for the week at 5 minute intervals, note this adjusts as time interval size changes. The efficiency is greater for denser schedules.