# @geeebe/common

> Helpers

Latest version **1.0.79** (published 2021-06-14) · ISC license · 0 weekly downloads

## Install

```sh
npm install @geeebe/common
pnpm add @geeebe/common
yarn add @geeebe/common
bun add @geeebe/common
```

Provides the command `geeebe`.

## 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.0.79 |
| Published | 2021-06-14 |
| First published | 2018-05-04 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 41.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Greg Bacchus |
| Maintainers | gregbacchus |
| Keywords | typescript, tslint, ts-node, jest, ts-jest, nodemon, tsc, setup |

## Links

- npm: https://www.npmjs.com/package/@geeebe/common
- Repository: https://github.com/gregbacchus/geeebe-common
- Homepage: https://github.com/gregbacchus/geeebe-common#readme
- Issues: https://github.com/gregbacchus/geeebe-common/issues
- npm.io page: https://npm.io/package/@geeebe/common

## Dependencies (1)

- [commander](https://npm.io/package/commander.md) ^7.2.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 1.0.79 (latest) — 2021-06-14
- 1.0.78 — 2021-06-12
- 1.0.77 — 2021-06-12
- 1.0.76 — 2020-12-24
- 1.0.75 — 2020-03-09
- 1.0.74 — 2020-03-04
- 1.0.73 — 2020-03-04
- 1.0.72 — 2020-02-14
- 1.0.71 — 2020-02-11
- 1.0.70 — 2020-02-11
- 1.0.69 — 2020-02-09
- 1.0.68 — 2020-02-09
- 1.0.67 — 2020-02-09
- 1.0.66 — 2020-02-09
- 1.0.65 — 2020-02-09
- … 58 more at https://npm.io/package/@geeebe/common/versions

## README

# `@geeebe/common`

This library has tiny bit of useful code, plus a util for setting up a `typescript` project with some common useful settings including `ts-node`, `tslint` and `jest`.

## Getting Started

In empty project directory.

```bash
npm init
# fill in details asked (defaults will do)
npm i @geeebe/common
npx geeebe init
```

This will do the following for your project

* create `.editorconfig`, `.gitignore` and `.npmignore`
* install `typescript` and `ts-node`
* install and configure `tslint`
* install `jest` with `ts-jest` and create a starter config
* install and configure `nodemon`

To get started, write some `typescript` code in `src/index.ts` and run it.

To run, either use:

* `npm start` to run one-off using `ts-node`
* `npm run watch` to run and watch for changes using `nodemon` and `ts-node`
* `npm run build` to build output to `dist/` using `tsc`

Also useful:

* `npm test` to run `jest` tests in the `test/` directory (looking for `*.test.ts` files)
* `npm run lint` to run `tslint`

## Included Code

Not too much here...

HTTP response status

```typescript
import { Statuses } from '@geeebe/common';

// ...

if (status === Statuses.NOT_FOUND) {} // 404
```

Some simple functions for time and duration

```typescript
import { Time } from '@geeebe/common';

const fiveMinutes = Time.minutes(5); // 5 min in ms = 5 * 60 * 1000
const sevenHours = Time.hours(7); // 7 hours in ms
const someTime = Time.days(2) + Time.hours(3) + Time.seconds(2);

// and then
const hours = Time.toHours(sevenHours);
// etc

// also
const fourHoursAgo = Time.past(Time.hours(4)); // Date() of 4 hours ago
const future = Time.future(Time.seconds(45)); // or in the future
```

Methods:

* `ms(ms: number): Duration`
* `seconds(s: number): Duration`
* `minutes(m: number): Duration`
* `hours(h: number): Duration`
* `days(d: number): Duration`
* `toMs(d: Duration): number`
* `toSeconds(d: Duration): number`
* `toMinutes(d: Duration): number`
* `toHours(d: Duration): number`
* `toDays(d: Duration): number`
* `past(interval: Duration): Date`
* `future(interval: Duration): Date`

Constants:

* `SECOND = 1000`
* `MINUTE = 60 * Time.SECOND`
* `HOUR = 60 * Time.MINUTE`
* `DAY = 24 * Time.HOUR`

Async sleep function

```typescript
await sleep(Time.seconds(45));
```

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