# neuron-normalize

> neuron-normalize

Latest version **1.0.2** (published 2015-10-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install neuron-normalize
pnpm add neuron-normalize
yarn add neuron-normalize
bun add neuron-normalize
```

## 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.2 |
| Published | 2015-10-12 |
| First published | 2015-10-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | zisasign |
| Maintainers | kael, zisasign |
| Keywords | neuron-normalize |

## Links

- npm: https://www.npmjs.com/package/neuron-normalize
- Repository: https://github.com/neuron-js/neuron-normalize
- Homepage: https://github.com/neuron-js/neuron-normalize#readme
- Issues: https://github.com/neuron-js/neuron-normalize/issues
- npm.io page: https://npm.io/package/neuron-normalize

## Dependencies (1)

- [path](https://npm.io/package/path.md) ^0.12.7

## Recent versions

- 1.0.2 (latest) — 2015-10-12
- 1.0.1 — 2015-10-12
- 1.0.0 — 2015-10-12
- 0.0.0 — 2015-10-09

## README

[![NPM version](https://badge.fury.io/js/neuron-normalize.svg)](http://badge.fury.io/js/neuron-normalize)
[![npm module downloads per month](http://img.shields.io/npm/dm/neuron-normalize.svg)](https://www.npmjs.org/package/neuron-normalize)
[![Build Status](https://travis-ci.org/neuron-js/neuron-normalize.svg?branch=master)](https://travis-ci.org/neuron-js/neuron-normalize)
[![Dependency Status](https://david-dm.org/neuron-js/neuron-normalize.svg)](https://david-dm.org/neuron-js/neuron-normalize)

# neuron-normalize

<!-- description -->
Normalize a module id to a url to a standard pathname.

## Install

```sh
$ npm install neuron-normalize --save
```

## Usage

```js

var options = {
  root: '/mod'
};

var normalize = require('neuron-normalize')(options);

normalize.parse('zepto');
->
{
    package: 'zepto@*',
    package_name: 'zepto',
    id: 'zepto@*/zepto.js',
    version: '*',
    path: '/zepto.js'
}

normalize.to_url('zepto');
->
'/mod/zepto/*/zepto.js'

normalize.to_package('/mod/zepto/*/zepto.js');
->
{
    package: 'zepto@*',
    package_name: 'zepto',
    id: 'zepto@*/zepto.js',
    version: '*',
    path: '/zepto.js'
}

```

### options
- root `String` Absolute path from root to the module. **Required**

## Module File Object

type: `Object`
    - package: `<module_name>@<version>`

    - package_name: `<module_name>`

    - id: `<module_name>@<version><file_path>`

    - version: `<major>.<minor>.<patch>`, default to `'*'`

    - path: `/path/to/<filename>.<ext>`, default to `/<package-name>.js`

## API

### normalize.parse(id)
- id `String` formatted module id

Returns `Object` Module File Object

### normalize.to_url(id)
- id `String` formatted module id

```js
'zepto@1.0.0/lib/zepto.js'
```

Returns `Path` Absolute pathname of a file to the id, or `undefined` if not id passed in.
```js
'/mod/zepto/1.0.0/lib/zepto.js'
```

### normalize.to_package(pathname)
- pathname `Path` Absolute pathname of a file

```js
'/mod/zepto/*/zepto.js'
```

Returns `Object` Module File Object

## License

MIT

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