# simple-clock

> Simple package to manage and format times and dates in your projects

Latest version **1.0.1** (published 2018-03-30) · MIT-Clause license · 0 weekly downloads

## Install

```sh
npm install simple-clock
pnpm add simple-clock
yarn add simple-clock
bun add simple-clock
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2018-03-30 |
| First published | 2018-03-30 |
| Weekly downloads | 0 |
| License | MIT-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Ouandi Mbiandja Hoffer Fleury |
| Maintainers | leonhard |
| Keywords | clock, node, date, calendar, format, time |

## Links

- npm: https://www.npmjs.com/package/simple-clock
- Repository: https://github.com/HofferLeonhard/simple-clock
- Homepage: https://github.com/HofferLeonhard/simple-clock#readme
- Issues: https://github.com/HofferLeonhard/simple-clock/issues
- npm.io page: https://npm.io/package/simple-clock

## 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

- 1.0.1 (latest) — 2018-03-30
- 1.0.0 — 2018-03-30

## README

# simple-clock
Simple package to manage clock in your projects.

[![NPM version](https://img.shields.io/npm/v/simple-clock.svg)](https://www.npmjs.com/package/simple-clock)

## How to use

#### Install it as npm dependencies

```bash
npm install simple-clock
```

#### Run the app

Then, to run app, you just have to run command :

```bash
node index.js
```

This will show you results of the operations performed


#### Possibles configurations

##### Setting simple parameters

Call the getTime function to get clock time value with a type of a result. 
Types arguments which are possible are :

	- h 		: to get hour
	- min 		: to get minute
	- s 		: to get seconds
	- ms 		: to get Milliseconds
	- toMilli 	: to convert time format to millis
	- d 		: to get day
	- m 		: to get month
	- y 		: to get year
	- full 		: to get full date with format : h:m:s-d/m/y


###### Example

```js
	var fullTime = require("./index.js").getTime("h");
	var fullTime = require("./index.js").getTime("min");
	var fullTime = require("./index.js").getTime("toMilli");
	var fullTime = require("./index.js").getTime("full");
```


##### Combine parameters
You can combine multiples parameters to format your result and get what you want
For example, you can get time by combine hour, minute and second like: h:min:s or h/min/s

You can get full data by doing : 
	"h:min:s-d/m/y" or "h/min/s-d-m-y" or ...

NB: only these separators are available 
	
    ":" 		: only to separate arguments, but not group, for example, we can do "h:min:s-d/m/y" but not "h:min:s:d/m/y"
	"/" 		: only to separate arguments, but not group, for example, we can do "h:min:s-d/m/y" but not "h:min:s/d/m/y"
	"-" 		: when use to separate arguments, it can't been use to separate group of arguments, for example, we can do 
		  "h-min-s d/m/y" but not "h-min-s-d/m/y"
	espace(" ") : only to separate group of arguments, for example, we can do "h:min:s d/m/y" but not "h min s-d/m/y"



## License

[MIT](LICENSE)


Enjoy it !

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