# deformat

> Deformat is the contrary of format, inspired by express/koa route, which makes parsing string with template really simple

Latest version **1.2.0** (published 2015-02-28) · ISC license · 0 weekly downloads

## Install

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

## 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.2.0 |
| Published | 2015-02-28 |
| First published | 2014-12-04 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | ft |
| Maintainers | ftft1885 |
| Keywords | format, nginx, log_format, access.log, parser |

## Links

- npm: https://www.npmjs.com/package/deformat
- Repository: https://github.com/chunpu/deformat
- Issues: https://github.com/chunpu/deformat/issues
- npm.io page: https://npm.io/package/deformat

## Alternatives

- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads

## Recent versions

- 1.2.0 (latest) — 2015-02-28
- 1.1.5 — 2014-12-16
- 1.0.4 — 2014-12-04
- 1.0.3 — 2014-12-04
- 1.0.2 — 2014-12-04
- 1.0.1 — 2014-12-04
- 1.0.0 — 2014-12-04

## README

deformat
===

[![Build status][travis-image]][travis-url]
[![NPM version][npm-image]][npm-url]
[![Downloads][downloads-image]][downloads-url]
[![Dependency Status][david-image]][david-url]
[npm-image]: https://img.shields.io/npm/v/deformat.svg?style=flat-square
[npm-url]: https://npmjs.org/package/deformat
[downloads-image]: http://img.shields.io/npm/dm/deformat.svg?style=flat-square
[downloads-url]: https://npmjs.org/package/deformat
[david-image]: http://img.shields.io/david/chunpu/deformat.svg?style=flat-square
[david-url]: https://david-dm.org/chunpu/deformat


Deformat is the contrary of format, inspired by express/koa route, which makes parsing string with template really simple

Installation
---

```sh
npm i deformat
```

Usage
---

```js
var Deformat = require('deformat')
var deformat = Deformat('$foo $bar') // init template
deformat.exec('myfoo mybar') // exec a string like regexp
// => {foo: "myfoo", bar: "mybar"}
```

Demo
---

Parse nginx access log is such a pain because `split(/\s+/)` will fail to work if there is **space** in request url or other nginx var

Deformat can parse nginx default log_format **combined** access log clearly and easily

```nginx
log_format combined '$remote_addr - $remote_user [$time_local] '
    '"$request" $status $body_bytes_sent '
    '"$http_referer" "$http_user_agent"';
```

```js
var combined = '$remote_addr - $remote_user [$time_local] "$request" $status $body_bytes_sent "$http_referer" "$http_user_agent"'

var log = '192.168.203.111 - - [03/Dec/2014:22:07:37 -0800] "GET /api/foo/bar?key=value&key=has space&key has \x22&key2=var2 HTTP/1.1" 404 576 "-" "Mozilla/5.0 (Windows NT 6.3; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/39.0.2171.71 Safari/537.36"'

Deformat(combined).exec(log)
// => output
{
    remote_addr: '192.168.203.111',
    remote_user: '-',
    time_local: '03/Dec/2014:22:07:37 -0800',
    request: 'GET /api/foo/bar?key=value&key=has space&key has "&key2=var2 HTTP/1.1',
    status: '404',
    body_bytes_sent: '576',
    http_referer: '-',
    http_user_agent: 'Mozilla/5.0 (Windows NT 6.3; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/39.0.2171.71 Safari/537.36'
}
```

Tips
---

`$var` is sugar for `${var}`

```js
Deformat('${foo}someword$bar').exec('myfoosomewordmybar')
// => 
{
    foo: 'myfoo',
    bar: 'mybar'
}
```

You can just skip chars by using `*`

```js
Deformat('$foo * $bar').exec('myfoo xxx-{} ##yyy zzz^( mybar')
// => 
{
    foo: 'myfoo',
    bar: 'mybar'
}
```

Options
---

support [RegExp flags](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp)

```js
var deformat = Deformat('foo $bar', {flags: 'i'})
deformat.exec('FOO bar')
// =>
{
	bar: 'bar'
}
```

License
---

[![License][license-image]][license-url]

[travis-image]: https://img.shields.io/travis/chunpu/deformat.svg?style=flat-square
[travis-url]: https://travis-ci.org/chunpu/deformat
[license-image]: http://img.shields.io/npm/l/deformat.svg?style=flat-square
[license-url]: #

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