# socketerrors

> Maps socket errors to SocketError objects subclassing httperrors.

Latest version **1.0.0** (published 2020-02-03) · BSD license · 0 weekly downloads

## Install

```sh
npm install socketerrors
pnpm add socketerrors
yarn add socketerrors
bun add socketerrors
```

## 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.0 |
| Published | 2020-02-03 |
| First published | 2015-06-08 |
| Weekly downloads | 0 |
| License | BSD |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 6.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Alex J Burke |
| Maintainers | alexjeffburke |

## Links

- npm: https://www.npmjs.com/package/socketerrors
- Repository: https://github.com/alexjeffburke/node-socketerrors
- Homepage: https://github.com/alexjeffburke/node-socketerrors#readme
- Issues: https://github.com/alexjeffburke/node-socketerrors/issues
- npm.io page: https://npm.io/package/socketerrors

## Dependencies (2)

- [httperrors](https://npm.io/package/httperrors.md) 2.0.1
- [createerror](https://npm.io/package/createerror.md) 1.1.0

## Recent versions

- 1.0.0 (latest) — 2020-02-03
- 0.3.0 — 2017-10-30
- 0.2.0 — 2016-02-16
- 0.1.1 — 2015-06-08
- 0.1.0 — 2015-06-08
- 0.0.1 — 2015-06-08

## README

# node-socketerrors

[![NPM version](https://img.shields.io/npm/v/socketerrors.svg)](http://badge.fury.io/js/socketerrors)
[![Build Status](https://img.shields.io/travis/alexjeffburke/node-socketerrors/master.svg)](https://travis-ci.org/alexjeffburke/unode-socketerrors)

Exposes a function mapping socket errors to SocketError objects.

The defined SocketError objects are created via
<a href="https://github.com/One-com/node-createerror">createerror</a>.

## Installation

Make sure you have node.js and npm installed, then run:

    npm install socketerrors

## Usage

The primary use case is wrapping errors originating from socket operations:

    var http = require('http');
    var socketErrors = require('socketerrors');

    http.get('nonexistent').on('error', function (err) {
        var socketError = socketErrors(err);

        console.warn(socketError.toString()); // ECONNREFUSED: connect ECONNREFUSED
    });

Other errors will be marked as not being socket errors:

    var socketErrors = require('socketerrors');

    var err = new Error();
    var socketError = socketErrors(err);

    if (socketError.NotSocketError) {
        // what am I?
    }

## Mappings

The following is a list of socket errors mapped by this module:

- EADDRINFO
- ECONNABORTED
- ECONNREFUSED
- ECONNRESET
- ENETDOWN
- ENETRESET
- ENETUNREACH
- ETIMEDOUT

## License

3-clause BSD license -- see the `LICENSE` file for details.

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