# resin-cli-errors

> DEPRECATED - Resin.io CLI error interpreter

Latest version **1.2.1** (published 2018-05-04) · Apache-2.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install resin-cli-errors
pnpm add resin-cli-errors
yarn add resin-cli-errors
bun add resin-cli-errors
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.2.1 |
| Published | 2018-05-04 |
| First published | 2015-09-11 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 22.6 KB |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Juan Cruz Viotti |
| Maintainers | resin.io |
| Keywords | resin, errors, error, cli |

## Links

- npm: https://www.npmjs.com/package/resin-cli-errors
- Repository: https://github.com/resin-io-modules/resin-cli-errors
- Issues: https://github.com/resin-io-modules/resin-cli-errors/issues
- npm.io page: https://npm.io/package/resin-cli-errors

## Dependencies (1)

- [lodash](https://npm.io/package/lodash.md) ^3.10.1

## Alternatives

- [@sentry/react-native](https://npm.io/package/@sentry/react-native.md) — 2.6M weekly downloads
- [@ardatan/aggregate-error](https://npm.io/package/@ardatan/aggregate-error.md) — 708.1K weekly downloads
- [custom-error-generator](https://npm.io/package/custom-error-generator.md) — 2.0K weekly downloads
- [@technik-sde/prosemirror-recreate-transform](https://npm.io/package/@technik-sde/prosemirror-recreate-transform.md) — 1.5K weekly downloads
- [@suchipi/error-utils](https://npm.io/package/@suchipi/error-utils.md) — 78 weekly downloads

## Recent versions

- 1.2.1 (latest) — 2018-05-04
- 1.2.0 — 2016-03-03
- 1.1.1 — 2015-12-04
- 1.1.0 — 2015-10-15
- 1.0.2 — 2015-10-02
- 1.0.1 — 2015-10-01
- 1.0.0 — 2015-09-11

## README

resin-cli-errors
----------------

[![npm version](https://badge.fury.io/js/resin-cli-errors.svg)](http://badge.fury.io/js/resin-cli-errors)
[![dependencies](https://david-dm.org/resin-io-modules/resin-cli-errors.png)](https://david-dm.org/resin-io-modules/resin-cli-errors.png)
[![Build Status](https://travis-ci.org/resin-io-modules/resin-cli-errors.svg?branch=master)](https://travis-ci.org/resin-io-modules/resin-cli-errors)
[![Build status](https://ci.appveyor.com/api/projects/status/bv3j3fe5pe3dw7j6/branch/master?svg=true)](https://ci.appveyor.com/project/resin-io/resin-cli-errors/branch/master)

Join our online chat at [![Gitter chat](https://badges.gitter.im/resin-io/chat.png)](https://gitter.im/resin-io/chat)

Resin.io CLI error interpreter.

This package is now deprecated
====

Resin-cli-errors is now built into [Resin CLI](https://github.com/resin-io/resin-cli) itself, so this package is not maintained, and should not be used.

Role
----

The intention of this module is to provide an error interpreter to translate common error codes to user friendly and more helpful messages.

Installation
------------

Install `resin-cli-errors` by running:

```sh
$ npm install --save resin-cli-errors
```

Documentation
-------------

<a name="module_errors.interpret"></a>
### errors.interpret(error) ⇒ <code>String</code>
**Kind**: static method of <code>[errors](#module_errors)</code>  
**Summary**: Interpet an error instance  
**Returns**: <code>String</code> - error message  
**Access:** public  

| Param | Type | Description |
| --- | --- | --- |
| error | <code>Error</code> | error |

**Example**  
```js
error = new Error()
error.code = 'ENOGIT'

message = errors.interpret(error)

console.log(message)
> Git is not installed on this system.
> Head over to http://git-scm.com to install it and run this command again.
```

Support
-------

If you're having any problem, please [raise an issue](https://github.com/resin-io-modules/resin-cli-errors/issues/new) on GitHub and the Resin.io team will be happy to help.

Tests
-----

Run the test suite by doing:

```sh
$ gulp test
```

Contribute
----------

- Issue Tracker: [github.com/resin-io-modules/resin-cli-errors/issues](https://github.com/resin-io-modules/resin-cli-errors/issues)
- Source Code: [github.com/resin-io-modules/resin-cli-errors](https://github.com/resin-io-modules/resin-cli-errors)

Before submitting a PR, please make sure that you include tests, and that [coffeelint](http://www.coffeelint.org/) runs without any warning:

```sh
$ gulp lint
```

License
-------

The project is licensed under the Apache 2.0 license.

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