# time-cluster

> clusters objects into timeframes

Latest version **0.0.1** (published 2015-09-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install time-cluster
pnpm add time-cluster
yarn add time-cluster
bun add time-cluster
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2015-09-21 |
| First published | 2015-09-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Phalanstere |
| Maintainers | phalanstere |

## Links

- npm: https://www.npmjs.com/package/time-cluster
- Repository: https://github.com/Phalanstere/TimeCluster
- Homepage: https://github.com/Phalanstere/TimeCluster#readme
- Issues: https://github.com/Phalanstere/TimeCluster/issues
- npm.io page: https://npm.io/package/time-cluster

## Recent versions

- 0.0.1 (latest) — 2015-09-21

## README

# TimeCluster

## Description
It might occur to you that you have a lot of timestamped objects that you want to cluster. 




## Features:

- You pass a folder name and receive image information of all the visual files that can be found in the folder and its subdirectories 

```html
    // you can embed the file via node.js require command 
	var TimeCluster = require("./lib/timeCluster.js"); 
```		
- then you define an object and pass an array of timestamped objects
	
```html	
	var x = new TimeCluster(list);
```		
- you can specify a timframe, like this: 

```html		
	var x = new TimeCluster(list, "day"); // valid calls are "minute", "hour", "day", "week", "year"
```	

- and you can also specify the field which contains the timestamp

```html			
	var x = new TimeCluster(list, "day", "date");  // default is "time"	
```	

- The functions returns an array of clustered objects

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