# sla_work_time

> SLA work time [0.0.4]

Latest version **0.0.5** (published 2023-07-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install sla_work_time
pnpm add sla_work_time
yarn add sla_work_time
bun add sla_work_time
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2023-07-28 |
| First published | 2022-11-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=16 |
| Dependencies | 1 |
| Unpacked size | 170.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | sawrozpdl |
| Maintainers | sawrozpdl |
| Keywords | sla, work, time, deadline, minutes, addition, hours, moment, date |

## Links

- npm: https://www.npmjs.com/package/sla_work_time
- Repository: https://github.com/sawrozpdl/sla_work_time
- Homepage: https://sawrozpdl.github.io/sla_work_time
- Issues: https://github.com/sawrozpdl/sla_work_time/issues
- npm.io page: https://npm.io/package/sla_work_time

## Dependencies (1)

- [moment](https://npm.io/package/moment.md) ^2.29.4

## Alternatives

- [@js-joda/timezone](https://npm.io/package/@js-joda/timezone.md) — 383.4K weekly downloads
- [chartjs-adapter-moment](https://npm.io/package/chartjs-adapter-moment.md) — 210.8K weekly downloads
- [strftime](https://npm.io/package/strftime.md) — 171.2K weekly downloads
- [vue-flatpickr-component](https://npm.io/package/vue-flatpickr-component.md) — 115.8K weekly downloads
- [timepicker](https://npm.io/package/timepicker.md) — 51.0K weekly downloads

## Recent versions

- 0.0.5 (latest) — 2023-07-28
- 0.0.4 — 2022-12-09
- 0.0.3 — 2022-12-01
- 0.0.1 — 2022-11-19

## README

<h2 align='center'>
 SLA work time [0.0.4]
</h2>

<h3 align='center'>
A duration addition/validation algorithm with work hours and skip days(holidays) consideration. [featuring momentjs]
</h3>

---

<p align="center">
  <a href="https://www.npmjs.com/package/sla_work_time">
    <img alt= "NPM" src="https://img.shields.io/npm/v/sla_work_time.svg">
  </a>
  <a href="https://standardjs.com">
    <img alt="JavaScript Style Guide" src="https://img.shields.io/badge/code_style-standard-brightgreen.svg">
  </a>
  <a href="https://github.com/sawrozpdl/sla_work_time/actions?query=workflow%3A%22Node.js+CI%22">
    <img alt="Github Actions CI Status" src="https://github.com/sawrozpdl/sla_work_time/actions/workflows/main.yml/badge.svg">
  </a>
  <a href="https://codeclimate.com/github/sawrozpdl/sla_work_time/maintainability">
    <img alt= "Maintainability" src="https://api.codeclimate.com/v1/badges/a99a88d28ad37a79dbf6/maintainability">
  </a>
</p>

[View demo](https://sawrozpdl.github.io/sla_work_time)

## Installation

```bash
npm i sla_work_time
```

or

```bash
yarn add sla_work_time
```

## Usage

```tsx
import { setSkipDays, addMinutes, configure, utils } from 'sla_work_time';

configure({
  // Setting work hours as 8:30AM to 5:30PM
  startAM: 8.5,
  endPM: 17.5,
});

setSkipDays([
  // Add DISTINCT holidays/days to exclude in { startDate, endDate (optional) } format.
  {
    startDate: '2022-11-25',
  },
  {
    startDate: '2022-11-29',
    endDate: '2022-11-30',
  },
  {
    startDate: '2022-12-02',
    endDate: '2022-12-12',
  },
]);

// Supports Date[] format (does internal duplicate removal->sorting->parsing this way)
// setSkipDays(['2022-12-01', '2022-12-02', '2022-12-03', '2022-12-05'])

const newDate = addMinutes('2022-11-28T16:18:44', 3600);

console.log(utils.formatDate(newDate, 'YYYY-MM-DDTHH:mm:ss')); // 2022-12-19T13:18:00
```
<br/>

**<h3 align='center'>! NOTE !</h3>**

To keep the system's list of holidays up-to-date, the setSkipDays function should be periodically called to update the in-memory list. This can be done either through an ETL job or periodic API calls to inject updated holiday information into the system. The service layer of the system is responsible for handling these updates.

<br/>

### Available methods

---

| Method                   | Params                                                 | Description                                                         |
| ------------------------ | ------------------------------------------------------ | ------------------------------------------------------------------- |
| addMinutes \|\| addHours | (date, minutes \|\| hours, config: DurationAddOptions) | Adds duration to the date following the config options.             |
| toNextWorkTime           | (date: DateTime, fixTime: Boolean = true)              | Gets the given date back to valid work day and hours if it's not    |
| validateSkipDay          | (date: DateTime, fixTime: Boolean = true)              | Gets the date out of holiday (if it's in one)                       |
| configure                | (config: { startAM, endPM })                           | Sets the work hours for any day.                                    |
| setSkipDays              | (skipDays: [{ startDate, endDate }] \|\| Date[])                   | Sets date to exclude from minute additions (For instance, holidays) |

---

## Description

These exposed functions add durations to a date considering work hours, week ends and skip days(holidays). For example, adding 25 minutes to the date `Friday 05:55PM` would result in `Monday 09:20AM` for [Mon-Fri] & [9AM - 6PM] work hour settings.

## Contributing

---

Fee free to open a pull request with detailed title and description about the feature.

For reporting any bug/issues make sure to add a detailed bug reproduction process(a sandbox link if possible) in the description.

## License

MIT © [sawrozpdl](https://github.com/sawrozpdl)

---
_Source: https://npm.io/package/sla_work_time · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._