Opened Closed

Provides availabiltiy and near-to-close information from periods.

const OpenedClosed = require("opened-closed");

const store = new OpenedClosed({
  timezone: "GMT+0100",
  openings: {
    monday: [
      { start: "10:00", end: "13:00" },
      { start: "15:00", end: "18:00" }
    ]
  }
});

console.log(store.opened());

Summary

• Installation
• Usage
• API
• Contributing

Installation

• Web
• NPM

Web

Include the following script in your project:

<script
  type="text/javascript"
  src="https://raw.githack.com/khalyomede/opened-closed/master/dist/opened-closed.min.js"
></script>

NPM

1. Include Opened Closed in your dependencies:

npm install --save opened-closed@0.*

2. Import it in your script:

const OpenedClosed = require('opened-closed');

Usage

All the examples can be found in the folder example of this repository.

• Example 1: checking if a store is opened now
• Example 2: adding exceptional closings dates
• Example 3: getting the opening state as a string
• Example 4: changing the language
• Example 5: get the "store closes in" in seconds
• Example 6: get the "store closes in" as a date

Example 1: checking if a store is opened now

const OpenedClosed = require("opened-closed");

const store = new OpenedClosed({
  timezone: "GMT+0100",
  openings: {
    monday: [
      { start: "10:00", end: "13:00" },
      { start: "15:00", end: "18:00" }
    ]
  }
});

console.log(store.opened());

Example 2: adding exceptional closings dates

const OpenedClosed = require("opened-closed");

const store = new OpenedClosed({
  timezone: "GMT+0100",
  openings: {
    monday: [
      { start: "10:00", end: "13:00" },
      { start: "15:00", end: "18:00" }
    ],
    tuesday: [
      { start: "10:00", end: "13:00" },
      { start: "15:00", end: "18:00" }
    ]
  },
  closings: [
    {
      reason: "Christmas", // optional
      from: new Date("2018-12-25 00:00:00 GMT+0100"),
      to: new Date("2018-12-25 23:59:59 GMT+0100")
    }
  ]
});

Example 3: getting the opening state as a string

const OpenedClosed = require("opened-closed");

const store = new OpenedClosed({
  timezone: "GMT+0100",
  openings: {
    monday: [
      { start: "10:00", end: "13:00" },
      { start: "15:00", end: "18:00" }
    ]
  }
});

console.log(store.availability());

Example 4: changing the language

const OpenedClosed = require("opened-closed");

const store = new OpenedClosed({
  timezone: "GMT+0100",
  openings: {
    monday: [
      { start: "10:00", end: "13:00" },
      { start: "15:00", end: "18:00" }
    ]
  },
  language: {
    opened: "ouvert",
    closed: "fermé"
  }
});

console.log(store.availability());

Example 5: get the store closes in in seconds

const OpenedClosed = require("opened-closed");

const store = new OpenedClosed({
  timezone: "GMT+0100",
  openings: {
    monday: [
      { start: "10:00", end: "13:00" },
      { start: "15:00", end: "18:00" }
    ]
  }
});

if (store.opened()) {
  console.log("closes in", store.closeIn());
} else {
  console.log(store.availability());
}

Example 6: get the store closes in as a date

const OpenedClosed = require("opened-closed");

const store = new OpenedClosed({
  timezone: "GMT+0100",
  openings: {
    wednesday: [{ start: "10:00", end: "19:00" }]
  }
});

if (store.opened()) {
  const closeAt = store.closeAt().toLocaleString(); // Maybe GMT+01 is not yours, so LocalString take care of it.

  console.log("will close at", closeAt);
} else {
  console.log(store.availability()); // "closed"
}

Contributing

• The code is located in src/main.ts. This is in TypeScript, but it also support plain JavaScript if you prefer.
• I prefer no dependencies for the moment, because this is help making a working web solution (opened to suggestions to improve the workflow).
• The web solution is simply removing the export statement, and using Gulp to transpile TypeScript in ES5 (opened to suggestions to improve the workflow).

1. Create an issue
2. Create a branche with the number of the issue in it: git checkout -b issue-36
3. Create tests inside test/
4. Light on dev: npm run dev
5. Make your changes on src/main.ts
6. Run test using npm run test
7. Copy main.ts in opened-closed.ts, remove the export = OpenedClosed; line
8. Run npm run prod
9. Create a Pull Request from your branch to master

Thank you for your time!