# node-taggun

> Typescript SDK for Taggun.io

Latest version **1.0.0** (published 2022-11-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install node-taggun
pnpm add node-taggun
yarn add node-taggun
bun add node-taggun
```

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2022-11-04 |
| First published | 2022-10-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=12.0 |
| Dependencies | 5 |
| Unpacked size | 10.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Justin Prather |
| Maintainers | jprather |
| Keywords | taggun, ocr, typescript, receipt, api |

## Links

- npm: https://www.npmjs.com/package/node-taggun
- Repository: https://github.com/justin-prather/node-taggun
- Homepage: https://github.com/justin-prather/node-taggun#readme
- Issues: https://github.com/justin-prather/node-taggun/issues
- npm.io page: https://npm.io/package/node-taggun

## Dependencies (5)

- [is-url](https://npm.io/package/is-url.md) ^1.2.4
- [mime-types](https://npm.io/package/mime-types.md) ^2.1.35
- [cross-fetch](https://npm.io/package/cross-fetch.md) ^3.1.5
- [pdf-to-base64](https://npm.io/package/pdf-to-base64.md) ^1.0.3
- [image-to-base64](https://npm.io/package/image-to-base64.md) ^2.2.0

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2022-11-04
- 0.0.1-development — 2022-11-01
- 0.0.0-development — 2022-10-24

## README

# node-taggun

[![npm package][npm-img]][npm-url]
[![Build Status][build-img]][build-url]
[![Downloads][downloads-img]][downloads-url]
[![Issues][issues-img]][issues-url]
[![Code Coverage][codecov-img]][codecov-url]
[![Commitizen Friendly][commitizen-img]][commitizen-url]
[![Semantic Release][semantic-release-img]][semantic-release-url]

typescript API wrapper for taggun.io

## Installs

```bash
npm install node-taggun
```

## Usage

```ts
import taggun from 'node-taggun';

taggun.init('TAGGUN API KEY', /**(url, base64) => { optional id gen function } */);

const tg = new taggun('https://example.com/my-file.pdf');
const data = await tg.process();

// {
//   "totalAmount": {
//     "data": 23.3,
//     "confidenceLevel": 0.7216666666666667
//   },
//   "taxAmount": {
//     "data": 3.04,
//     "confidenceLevel": 0.7216666666666667
//   },
//   "date": {
//     "data": "2016-12-22T12:00:00.000Z",
//     "confidenceLevel": 0.7216666666666667
//   },
//   "merchantName": {
//     "data": "Adina Apartment Hotel Auckland Britomart",
//     "confidenceLevel": 0.7216666666666667
//   },
//   ...
//   "confidenceLevel": 0.7216666666666667,
//   "error": "string"
// }
```

<!-- ## API

### myPackage(input, options?)

#### input

Type: `string`

Lorem ipsum.

#### options

Type: `object`

##### postfix

Type: `string`
Default: `rainbows`

Lorem ipsum. -->

[build-img]:https://github.com/justin-prather/node-taggun/actions/workflows/release.yml/badge.svg
[build-url]:https://github.com/justin-prather/node-taggun/actions/workflows/release.yml
[downloads-img]:https://img.shields.io/npm/dt/node-taggun
[downloads-url]:https://www.npmtrends.com/node-taggun
[npm-img]:https://img.shields.io/npm/v/node-taggun
[npm-url]:https://www.npmjs.com/package/node-taggun
[issues-img]:https://img.shields.io/github/issues/justin-prather/node-taggun
[issues-url]:https://github.com/justin-prather/node-taggun/issues
[codecov-img]:https://codecov.io/gh/justin-prather/node-taggun/branch/main/graph/badge.svg
[codecov-url]:https://codecov.io/gh/justin-prather/node-taggun
[semantic-release-img]:https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[semantic-release-url]:https://github.com/semantic-release/semantic-release
[commitizen-img]:https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
[commitizen-url]:http://commitizen.github.io/cz-cli/

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