# indicative-formatters

> A collection of formatters used by Indicative

Latest version **7.2.4** (published 2019-12-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install indicative-formatters
pnpm add indicative-formatters
yarn add indicative-formatters
bun add indicative-formatters
```

## 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 | 7.2.4 |
| Published | 2019-12-26 |
| First published | 2019-03-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 9.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | virk,poppinss |
| Maintainers | virk |

## Links

- npm: https://www.npmjs.com/package/indicative-formatters
- Repository: https://github.com/poppinss/indicative-formatters
- Homepage: https://github.com/poppinss/indicative-formatters#readme
- Issues: https://github.com/poppinss/indicative-formatters/issues
- npm.io page: https://npm.io/package/indicative-formatters

## Recent versions

- 7.2.4 (latest) — 2019-12-26
- 1.0.0 (alpha) — 2019-06-11
- 7.2.3 — 2019-12-09
- 7.2.2 — 2019-12-02
- 7.2.1 — 2019-07-09
- 7.2.0 — 2019-07-08
- 1.0.1 — 2019-07-07
- 7.1.1 — 2019-04-02
- 7.0.0 — 2019-04-01
- 6.0.1 — 2019-03-29
- 6.0.0 — 2019-03-29

## README

<div align="center">
  <img src="https://res.cloudinary.com/adonisjs/image/upload/q_100/v1562577951/Group_2_2x_ohgvej.png" width="600px">
</div>

<br />

# Indicative Formatters
> Collection of error formatters used by Indicative

[![circleci-image]][circleci-url] [![npm-image]][npm-url] ![](https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript)

Indicative has first class support for formatting error messages with the help of an Error formatter. This repo contains a handful of them.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
## Table of contents

- [Usage](#usage)
- [API Docs](#api-docs)
- [Maintainers](#maintainers)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Usage
Install the package from npm registry as follows:

```sh
npm i indicative-formatters

# yarn
yarn add indicative-formatters
```

and then use it as follows:

```ts
import { VanillaFormatter } from 'indicative-formatters'

const formatter = new VanillaFormatter()
formatter.addError('Required validation failed', 'username', { name: 'required', args: [] })

// Get all errors
formatter.toJSON()
```

## API Docs
Following are the autogenerated files via Typedoc

* [API](docs/README.md)

## Maintainers
[Harminder virk](https://github.com/thetutlage)

[circleci-image]: https://img.shields.io/circleci/project/github/poppinss/indicative-formatters/master.svg?style=for-the-badge&logo=circleci
[circleci-url]: https://circleci.com/gh/poppinss/indicative-formatters "circleci"

[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
[typescript-url]:  "typescript"

[npm-image]: https://img.shields.io/npm/v/indicative-formatters.svg?style=for-the-badge&logo=npm
[npm-url]: https://npmjs.org/package/indicative-formatters "npm"

[license-image]: https://img.shields.io/npm/l/indicative-formatters?color=blueviolet&style=for-the-badge
[license-url]: LICENSE.md "license"

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