# @datagica/parse-family

> Family status parser (married, single, no child, 2 children etc..)

Latest version **0.0.5** (published 2016-02-06) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install @datagica/parse-family
pnpm add @datagica/parse-family
yarn add @datagica/parse-family
bun add @datagica/parse-family
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2016-02-06 |
| First published | 2016-01-27 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Julian Bilcke |
| Maintainers | datagica |

## Links

- npm: https://www.npmjs.com/package/@datagica/parse-family
- Repository: https://github.com/datagica/parse-family
- Homepage: https://github.com/datagica/parse-family#readme
- Issues: https://github.com/datagica/parse-family/issues
- npm.io page: https://npm.io/package/@datagica/parse-family

## Dependencies (1)

- [xregexp](https://npm.io/package/xregexp.md) 3.0.0

## Recent versions

- 0.0.5 (latest) — 2016-02-06
- 0.0.4 — 2016-01-27

## README

Parse Family

Your marital status and your children, processed by a machine.

## Installation

    $ npm install --save @datagica/parse-family

## Usage

```javascript
import parseFamily from "@datagica/parse-family";

parseFamily(INPUT).then(result => {
  if (result == null) {
    console.log("not found")
  } else {
    console.log("found: ", result)
  }
}).catch(err => {
  console.log("invalid input data: "+err)
})
```

## Examples

```javascript
import parseFamily from "@datagica/parse-family";

parseFamily("married, two children.").then(..).catch(..)
{
  marital: 'married',
  children: 2,
  id: 'married-parent-of-2',
  label: 'married parent'
}

// I'm french. So it can also parse french, bien entendu.
parseFamily("marié, deux enfants.").then(..).catch(..)
{
  marital: 'married',
  children: 2,
  id: 'married-parent-of-2',
  label: 'married parent'
}
```

## TODO

- the family parser should support more text formats
- should support more languages, too

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