# duckling-client

> A client for [duckling](https://github.com/facebook/duckling).

Latest version **0.1.0** (published 2021-08-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install duckling-client
pnpm add duckling-client
yarn add duckling-client
bun add duckling-client
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2021-08-19 |
| First published | 2021-08-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 317.6 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Rik Hoffbauer |
| Maintainers | rik.hoffbauer |

## Links

- npm: https://www.npmjs.com/package/duckling-client
- Repository: https://github.com/rikhoffbauer/duckling-client
- Homepage: https://github.com/rikhoffbauer/duckling-client#readme
- Issues: https://github.com/rikhoffbauer/duckling-client/issues
- npm.io page: https://npm.io/package/duckling-client

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^0.21.1

## Recent versions

- 0.1.0 (latest) — 2021-08-19

## README

# duckling-client

A client for [duckling](https://github.com/facebook/duckling).

## Installation

```shell
# using npm
npm i duckling-client

# using yarn
yarn add duckling-client

# using pnpm
pnpm i duckling-client
```

## Usage

```typescript
import { DucklingClient } from "duckling-client";

const client = new DucklingClient({
    endpoint: "http://0.0.0.0:8000",
    locale: "nl_NL",
    dims: ["volume"],
});

const result = await client.parse("3ml ghb");

```

This gives the `result` variable a value that looks something like following:

```json
[
    {
        "body": "3ml",
        "start": 1,
        "value": {
            "value": 3,
            "type": "value",
            "unit": "millilitre"
        },
        "end": 4,
        "dim": "volume",
        "latent": false
    }
]
```

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