An open API service indexing awesome lists of open source software.

https://github.com/grimen/js-humanizer

A human/developer friendly value humanizer - for JavaScript/Node.
https://github.com/grimen/js-humanizer

data debug debugging format formatting humanize humanizer log logging print printing value

Last synced: 3 months ago
JSON representation

A human/developer friendly value humanizer - for JavaScript/Node.

Awesome Lists containing this project

README

        

# `js-humanizer` [![NPM version](https://badge.fury.io/js/%40grimen%2Fhumanizer.svg)](https://badge.fury.io/js/%40grimen%2Fhumanizer) [![Build Status](https://travis-ci.com/grimen/js-humanizer.svg?token=sspjPRWbecBSpceU8Jyn&branch=master)](https://travis-ci.com/grimen/js-humanizer) [![Coverage Status](https://codecov.io/gh/grimen/js-humanizer/branch/master/graph/badge.svg)](https://codecov.io/gh/grimen/js-humanizer)

*A developer friendly data/value humanizer for debugging/logging - for JavaScript/Node.*

## Introduction

*TODO*

## Install

Install using **npm**:

```bash
$ npm install @grimen/humanizer
```

Install using **yarn**:

```bash
$ yarn add @grimen/humanizer
```

## Use

Very basic `bytesize` **[example](https://github.com/grimen/js-humanizer/tree/master/examples/bytesize.js)**:

```javascript
const { bytesize } = require('@grimen/humanizer')

// TODO: add example

```

Very basic `duration` **[example](https://github.com/grimen/js-humanizer/tree/master/examples/duration.js)**:

```javascript
const { duration } = require('@grimen/humanizer')

// TODO: add example

```

## Test

Clone down source code:

```sh
$ make install
```

Run **colorful tests** using **jest**:

```sh
$ make test
```

## Related

- [**`python-humanizer`**](https://github.com/grimen/python-humanizer) - *"A developer friendly data/value humanizer for debugging/logging - for Python"*

## About

This project was mainly initiated - in lack of solid existing alternatives - to be used at our work at **[Markable.ai](https://markable.ai)** to have common code conventions between various programming environments where **Node.js** (for I/O heavy operations) is heavily used.

## License

Released under the MIT license.