# @etalab/fantoir-parser

> Analyseur de fichiers FANTOIR

Latest version **0.5.0** (published 2021-12-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install @etalab/fantoir-parser
pnpm add @etalab/fantoir-parser
yarn add @etalab/fantoir-parser
bun add @etalab/fantoir-parser
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.5.0 |
| Published | 2021-12-10 |
| First published | 2018-11-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 12 |
| Dependencies | 5 |
| Unpacked size | 13.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Jérôme Desboeufs |
| Maintainers | thimy, flightan, jdesboeufs, abulte |

## Links

- npm: https://www.npmjs.com/package/@etalab/fantoir-parser
- Repository: git@github.com:etalab/fantoir-parser
- npm.io page: https://npm.io/package/@etalab/fantoir-parser

## Dependencies (5)

- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [split2](https://npm.io/package/split2.md) ^4.1.0
- [pumpify](https://npm.io/package/pumpify.md) ^2.0.1
- [get-stream](https://npm.io/package/get-stream.md) ^6.0.1
- [into-stream](https://npm.io/package/into-stream.md) ^6.0.0

## Recent versions

- 0.5.0 (latest) — 2021-12-10
- 0.4.2 — 2019-12-10
- 0.4.1 — 2019-09-10
- 0.4.0 — 2019-04-18
- 0.3.0 — 2019-04-18
- 0.2.0 — 2019-04-17
- 0.1.1 — 2018-11-21
- 0.1.0 — 2018-11-21

## README

# fantoir-parser
Analyseur de fichiers FANTOIR

## Utilisation

### Analyser un Buffer ou une String

```js
const {parseBuffer} = require('@etalab/fantoir-parser')

const records = await parseBuffer(input, options)
```

### Analyser un flux (Stream)

```js
const {parseStream} = require('@etalab/fantoir-parser')

const records = await parseStream(inputStream, options)
```

### Créer un parser (TransformStream)

```js
const {createParser} = require('@etalab/fantoir-parser')

const parser = createParse(options)

input.pipe(parser).pipe(output)
```

### Configuration

| Nom du paramètre | Description |
| --- | --- |
| `accept` | Liste des types de valeurs acceptés (parmi `commune`, `voie`, `eof`). Par défaut `['voie']`. |
| `dateFormat` | Type de date attendu après l’extraction (parmi `iso`, `native`, `integer`). Par défaut `iso`. Le plus rapide est `integer`. |
| `memoizeDateFormat` | Booléen indiquant si on met en cache les valeurs obtenues lors de l’extraction des dates. Par défaut `false`. Pertinent pour `dateFormat: 'iso'`. |
| `computeCompleteIds` | Booléen indiquant si l’analyseur doit construire une identifiant complet avec date de début. Par défaut : `false` |

## Licence

MIT

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