{"id":21189213,"url":"https://github.com/uptick/event-time-utils","last_synced_at":"2025-03-14T20:42:22.593Z","repository":{"id":57231275,"uuid":"133442329","full_name":"uptick/event-time-utils","owner":"uptick","description":"A collection of utilities based around events with begins/ends timestamps","archived":false,"fork":false,"pushed_at":"2018-05-15T05:48:09.000Z","size":54,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-13T03:02:15.804Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/uptick.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-05-15T01:34:00.000Z","updated_at":"2019-06-04T13:34:47.000Z","dependencies_parsed_at":"2022-09-04T21:40:15.100Z","dependency_job_id":null,"html_url":"https://github.com/uptick/event-time-utils","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uptick%2Fevent-time-utils","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uptick%2Fevent-time-utils/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uptick%2Fevent-time-utils/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uptick%2Fevent-time-utils/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/uptick","download_url":"https://codeload.github.com/uptick/event-time-utils/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243646524,"owners_count":20324582,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-20T18:50:37.445Z","updated_at":"2025-03-14T20:42:22.559Z","avatar_url":"https://github.com/uptick.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# event-time-utils\n\n[![npm version](https://badge.fury.io/js/event-time-utils.svg)](http://badge.fury.io/js/event-time-utils)\n![Downloads](http://img.shields.io/npm/dm/event-time-utils.svg?style=flat)\n\nA collection of utilities based around events with begins/ends timestamps\n\n## Installation\n\nInstall the package with npm:\n\n```\nnpm install event-time-utils\n```\n\n## Usage\n\nThese utilities are intended to be used with any objects that have a `begins` / `ends` timestamp,\nformatted as a millisecond integer.\n\n### chronoEventsComparer\n\n`chronoEventsComparer` is used for sorting events by start time.\n\n```javascript\nimport moment from 'moment'\nimport { chronoEventsComparer } from 'event-time-utils'\n\nlet events = [\n  {\n    title: 'Dinner',\n    begins: +moment().set({hour: 19, minute: 0,}).startOf('minute').format('x'),\n    ends: +moment().set({hour: 20, minute: 0,}).startOf('minute').format('x'),\n  },\n  {\n    title: 'Breakfast',\n    begins: +moment().set({hour: 7, minute: 30,}).startOf('minute').format('x'),\n    ends: +moment().set({hour: 8, minute: 0,}).startOf('minute').format('x'),\n  },\n  {\n    title: 'Lunch',\n    begins: +moment().set({hour: 12, minute: 0,}).startOf('minute').format('x'),\n    ends: +moment().set({hour: 13, minute: 15,}).startOf('minute').format('x'),\n  },\n]\nlet sortedEvents = [...events,].sort(chronoEventsComparer)\n\nconsole.log(sortedEvents)\n// [{title: 'Breakfast', ...}, {title: 'Lunch', ...}, {title: 'Dinner', ...}]\n```\n\n### activeTime\n\n`activeTime` tells you the amount of total time spent within a set of events, given a `begins` and\n`ends` bound. Overlapping times are only counted once.\n\nFor this function to work, events require a key-serialisable unique `id` attribute. The time value\nis returned as a simplified two decimal place string count of hours.\n\n```javascript\nimport moment from 'moment'\nimport { activeTime } from 'event-time-utils'\n\nlet events = [\n  {\n    id: 1,\n    title: 'Eat Breakfast',\n    begins: +moment().set({hour: 6, minute: 30,}).startOf('minute').format('x'),\n    ends: +moment().set({hour: 7, minute: 0,}).startOf('minute').format('x'),\n  },\n  {\n    id: 2,\n    title: 'Shower',\n    begins: +moment().set({hour: 7, minute: 15,}).startOf('minute').format('x'),\n    ends: +moment().set({hour: 7, minute: 30,}).startOf('minute').format('x'),\n  },\n  {\n    id: 3,\n    title: 'Brush Teeth',\n    begins: +moment().set({hour: 7, minute: 20,}).startOf('minute').format('x'),\n    ends: +moment().set({hour: 7, minute: 25,}).startOf('minute').format('x'),\n  },\n]\nlet dayBegins = +moment().startOf('day').format('x')\nlet dayEnds = +moment().endOf('day').format('x')\nlet time = activeTime(events, dayBegins, dayEnds)\n\nconsole.log(time)\n// '0.75'\n```\n\n### eventsInRange\n\n`eventsInRange` returns a filtered set of events that fall within a specified `begins` and `ends`\nbound.\n\n```javascript\nimport moment from 'moment'\nimport { eventsInRange } from 'event-time-utils'\n\nlet events = [\n  {\n    title: 'Lunch Yesterday',\n    begins: +moment().subtract({days: 1,}).set({hour: 6, minute: 30,}).startOf('minute').format('x'),\n    ends: +moment().subtract({days: 1,}).set({hour: 7, minute: 0,}).startOf('minute').format('x'),\n  },\n  {\n    title: 'Lunch Today',\n    begins: +moment().set({hour: 7, minute: 15,}).startOf('minute').format('x'),\n    ends: +moment().set({hour: 7, minute: 30,}).startOf('minute').format('x'),\n  },\n  {\n    title: 'Lunch Tomorrow',\n    begins: +moment().add({days: 1,}).set({hour: 7, minute: 20,}).startOf('minute').format('x'),\n    ends: +moment().add({days: 1,}).set({hour: 7, minute: 25,}).startOf('minute').format('x'),\n  },\n]\nlet dayBegins = +moment().startOf('day').format('x')\nlet dayEnds = +moment().endOf('day').format('x')\nlet todaysEvents = eventsInRange(events, dayBegins, dayEnds)\n\nconsole.log(todaysEvents)\n// [{title: 'Lunch Today', ...}]\n```\n\n### stackEvents\n\n`stackEvents` returns a mutated set of events with an additional `stackIndex` attribute, with any\noverlapping events placed on a higher stack.\n\nThe input events can be supplied with their own `stackIndex` attribute, so all other events will\nstack around them.\n\nOptionally, you can provide a `margin` to which events will stack even if they don't overlap.\n\n```javascript\nimport moment from 'moment'\nimport { stackEvents } from 'event-time-utils'\n\nlet events = [\n  {\n    title: 'Eat Breakfast',\n    begins: +moment().set({hour: 6, minute: 30,}).startOf('minute').format('x'),\n    ends: +moment().set({hour: 7, minute: 0,}).startOf('minute').format('x'),\n  },\n  {\n    title: 'Shower',\n    begins: +moment().set({hour: 7, minute: 15,}).startOf('minute').format('x'),\n    ends: +moment().set({hour: 7, minute: 30,}).startOf('minute').format('x'),\n  },\n  {\n    title: 'Brush Teeth',\n    begins: +moment().set({hour: 7, minute: 20,}).startOf('minute').format('x'),\n    ends: +moment().set({hour: 7, minute: 25,}).startOf('minute').format('x'),\n  },\n]\nlet stackedEvents = stackEvents(events, 0)\n\nconsole.log(\n  'shower stack:', stackedEvents[1].stackIndex,\n  'brush teeth stack:', stackedEvents[2].stackIndex,\n)\n// shower stack: 0, brush teeth stack: 1\n```\n\n### nearestTime\n\n`nearestTime` rounds a given time value to the nearest given time unit.\n\n```javascript\nimport moment from 'moment'\nimport { nearestTime } from 'event-time-utils'\n\nlet vagueTime = +moment().set({hour: 7, minute: 7,}).startOf('minute').format('x')\nlet roundedTime = nearestTime(vagueTime, +moment.duration({minutes: 15,}))\n\nconsole.log(\n  moment(vagueTime, 'x').format(), 'rounded to:',\n  moment(roundedTime, 'x').format(),\n)\n// 2018-05-15T07:07:00+10:00 rounded to: 2018-05-15T07:00:00+10:00\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuptick%2Fevent-time-utils","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fuptick%2Fevent-time-utils","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuptick%2Fevent-time-utils/lists"}