# dayspan

> A date & schedule library to use for advanced calendars in TypeScript and JS

Latest version **1.1.0** (published 2019-06-04) · MIT license · 0 weekly downloads

## Install

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

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2019-06-04 |
| First published | 2018-05-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=6.9 |
| Dependencies | 1 |
| Unpacked size | 297.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 141 |
| Maintainers | clickermonkey |

## Links

- npm: https://www.npmjs.com/package/dayspan
- Repository: https://github.com/ClickerMonkey/dayspan
- Homepage: https://github.com/ClickerMonkey/dayspan#readme
- Issues: https://github.com/ClickerMonkey/dayspan/issues
- npm.io page: https://npm.io/package/dayspan

## Dependencies (1)

- [iteratez](https://npm.io/package/iteratez.md) 1.2.2

## Recent versions

- 1.1.0 (latest) — 2019-06-04
- 1.0.3 — 2019-06-02
- 1.0.2 — 2019-06-02
- 1.0.1 — 2019-06-02
- 1.0.0 — 2019-06-02
- 0.12.5 — 2019-04-17
- 0.12.4 — 2018-09-23
- 0.12.3 — 2018-09-23
- 0.12.2 — 2018-07-30
- 0.12.1 — 2018-07-28
- 0.12.0 — 2018-07-21
- 0.11.2 — 2018-07-14
- 0.11.1 — 2018-07-14
- 0.11.0 — 2018-07-13
- 0.10.1 — 2018-06-28
- … 11 more at https://npm.io/package/dayspan/versions

## README

# DaySpan

A date & schedule library to use for advanced calendars in TypeScript and JS.

- [Google Calendar Clone](https://clickermonkey.github.io/dayspan-vuetify/example/) checkout [dayspan-vuetify](https://github.com/ClickerMonkey/dayspan-vuetify)
- [Documentation](https://clickermonkey.github.io/dayspan/docs/)
- [Download JS](umd/dayspan.js)
- Install via `bower install dayspan` or `npm install dayspan`

### Features

- Schedules track how frequent events occur using 20+ properties
- Events can last minutes, hours, days, or weeks
- Events can occur all day, or 1 or more times during the day
- Events can have any day & time included as an event occurrence (they don't need to match the frequency of the schedule)
- Events can be excluded, cancelled, or have metadata (specific event occurrence, all in a given day, week, month, quarter, or year)
- Event occurrences can be moved
- Calendars can represent a span of days, weeks, months, or years
- Easily list the next/previous days that occur on a schedule
- Describe a schedule in a human friendly string
- Export and import schedules and calendars to plain objects for easy saving and loading
- Provides logic to help display intersecting events on a calendar

### TypeScript Example

```typescript
// A monthly calendar around today (string=event data type, any=schedule metadata type)
let cal = Calendar.months<string, any>();

// Every Monday 9:00 - 9:30
cal.addEvent({
  data: 'Weekly Meeting',
  schedule: {
    dayOfWeek: [Weekday.MONDAY],
    times: [9],
    duration: 30,
    durationUnit: 'minutes'
  }
});

// Dr. Appointment on 01/04/2018
cal.addEvent({
  data: 'Dr. Appointment',
  visible: false,
  schedule: {
    on: Day.build(2018, Month.APRIL, 1)
  }
});

// Mother's Day
cal.addEvent({
  id: 'someUserProvidedId',
  data: "Mother's Day",
  schedule: new Schedule({
    weekspanOfMonth: [1],         // 2nd
    dayOfWeek: [Weekday.SUNDAY],  // Sunday
    month: [Month.MAY]            // of May
  })
});

// The array of days in the month, each day has a list of the days events.
cal.days;

// Go to the next month
cal.next();

// Select this day and update the selection flags in the calendar days
cal.select(Day.build(2018, Month.APRIL, 12));

// Remove the schedule
cal.removeEvent('Weekly Meeting');

// A weekly calendar with custom MyEvent class
Calendar.weeks<MyEvent, any>();

// A daily calendar covering 3 days centered on today
Calendar.days<string, any>(3);

// A daily calendar covering 3 days starting with given date
Calendar.days<string, any>(3, Day.build(2018, Month.JUNE, 15), 0);
```

### JS Example

You just need to append `ds` to the beginning of the classes:

```javascript
// A monthly calendar around today
var cal = ds.Calendar.months();

// Every Monday 9:00 - 9:30
cal.addEvent({
  data: 'Weekly Meeting',
  schedule: {
    dayOfWeek: [ds.Weekday.MONDAY],
    times: [9],
    duration: 30,
    durationUnit: 'minutes'
  }
});

// Dr. Appointment on 01/04/2018
cal.addEvent({
  data: 'Dr. Appointment',
  schedule: new ds.Schedule({
    on: ds.Day.build(2018, ds.Month.APRIL, 1)
  })
});
```

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