@jumbojet/sscheduler v1.3.5

sscheduler

Flexible scheduler to find free time slots in the schedule of a resource (which could be a person, a meeting room, a car, etc...)

sscheduler can also intersect the availability of multiple resources in order to find the time slots at which all the resources are available.

Installation

npm install @digvan/sscheduler

Basic usage

As an example, let's say that we want to book a 1 hour appointment with a doctor in the month of february considering that:

• We can only book on weekdays from 9AM to 5PM

• We can't book between noon and 1PM (lunch time !)

• The doctor is on vacation the week of the 20th

• There are already two one-hour appointments booked on February 1st at 1PM and 2PM

import {Scheduler} from '@digvan/sscheduler';

const scheduler = new Scheduler();
const schedule = {
    from: '2019-01-10',
    to: '2019-01-17',
    duration: 60,
    interval: 60,
    timezone: "America/Los_Angeles",
    schedule: {
        weekdays: {
            from: '08:00', to: '17:00',
            unavailability: [
                { from: '12:00', to: '13:00' }
            ]
        },
        unavailability: [
            // two different types of unavailability structure
            { from: '2019-01-20 00:00', to: '2019-01-27 00:00' },
            { date: '2019-01-15', from: '14:00', to: '15:00' }
        ],
        allocated: [
          { from: '2019-02-01 13:00' , duration: 60 },
          { from: '2019-02-01 14:00' , duration: 60 }
        ]
    }
};
console.log(scheduler.getAvailabilityWithTimezone(schedule, "America/Los_Angeles"));

The returned value is a structure that looks like the following:

{
  '2017-02-01': [
    { time: '09:00', available: true },
    { time: '10:00', available: true }
    // ...
  ]
  // ...
}

Options

The possible options for the getAvailability function are:

Example:

{
  monday: {
    from: '09:00',
    to: '17:00',
    unavailability: [
      { from: '12:00', to: '13:00' }
    ]
  },
  custom_schedule: [
    { "date": "2017-01-23", "from": "12:00", "to": "17:00" },
  ]
}

Schedule intersection

Using the same example as before, let's say that we also need to book a room for our appointment.

So, we need to intersect the doctor's availability times with the room's availability times, considering that:

• We can only book the room on weekdays from 8AM to 8PM

• The room is out of service from February 6th to February 16th

import {Scheduler} from '@digvan/sscheduler';

const scheduler = new Scheduler();
const schedule1 = {
    from: '2019-01-10',
    to: '2019-01-17',
    duration: 60,
    interval: 60,
    timezone: "America/Los_Angeles",
    schedule: {
        weekdays: {
            from: '08:00', to: '17:00',
            unavailability: [
                { from: '12:00', to: '13:00' }
            ]
        },
        unavailability: [
            // two different types of unavailability structure
            { from: '2019-01-20 00:00', to: '2019-01-27 00:00' },
            { date: '2019-01-15', from: '14:00', to: '15:00' }
        ],
        allocated: [
          { from: '2019-02-01 13:00' , duration: 60 },
          { from: '2019-02-01 14:00' , duration: 60 }
        ]
    }
};
const schedule2 = {
    from: '2019-01-10',
    to: '2019-01-17',
    duration: 60,
    interval: 60,
    timezone: "CET",
    schedule: {
        weekdays: {
            from: '07:00', to: '18:00',
            unavailability: [
                { from: '13:00', to: '14:00' }
            ]
        },
        unavailability: [
            // two different types of unavailability structure
            { from: '2019-01-15 17:00', to: '2019-01-15 18:00' },
            { date: '2019-01-16', from: '17:00', to: '18:00' }
        ],
        allocated: [
          { from: '2019-02-01 13:00' , duration: 60 },
          { from: '2019-02-01 14:00' , duration: 60 }
        ]
    }
};
const availability = scheduler.getAvailabilityWithTimezone(schedule2, "America/Los_Angeles");

Build

npm install
gulp

Test

npm run compile
npm run test

Authors

• Mickael Burguet - Original author - ssense/sscheduler
• Matt Michel - ninjaPixel
• Khash Nejad - digvan

License

This project is licensed under the MIT License - see the LICENSE.md file for details.