# cordova-ml-kit

> Adds ML Kit support for Firebase

Latest version **0.0.2** (published 2019-06-05) · 0 weekly downloads

## Install

```sh
npm install cordova-ml-kit
pnpm add cordova-ml-kit
yarn add cordova-ml-kit
bun add cordova-ml-kit
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2019-06-05 |
| First published | 2019-04-03 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 13.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10 |
| Maintainers | antoniostipic |
| Keywords | firebase, ml-kit, ecosystem:cordova, cordova-android |

## Links

- npm: https://www.npmjs.com/package/cordova-ml-kit
- Repository: https://github.com/antoniostipic/cordova-ml-kit
- Issues: https://github.com/antoniostipic/cordova-ml-kit/issues
- npm.io page: https://npm.io/package/cordova-ml-kit

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.0.2 (latest) — 2019-06-05
- 0.0.1 — 2019-04-03

## README

# Cordova ML Kit

Implements ML Kit as Cordova plugin on iOS and Android.

## Installation

Run:

```
npm i cordova-ml-kit
```

## Features

At the moment only Text Recognition and Labeling Images on Android is supported! This plugin requires ``cordova-plugin-firebase``!

| Feature                | Android | Android (Cloud) | iOS | iOS (Cloud) |
|------------------------|---------|-----------------|-----|-------------|
| Text recognition       | [x]     | [x]             | [ ] | [ ]         |
| Face detection         | [ ]     |                 | [ ] |             |
| Barcode scanning       | [ ]     |                 | [ ] |             |
| Image labeling         | [x]     | [x]             | [ ] | [ ]         |
| Landmark recognition   |         | [ ]             |     | [ ]         |
| Custom model inference | [ ]     |                 | [ ] |             |

Some features of ML Kit are only available on device others only on cloud. Please see https://firebase.google.com/docs/ml-kit/ for more information!

## API Methods
### Text recognition

##### **`getText(img, options, success, error): void`**
Text recognition on device

#####  **`getTextCloud(img, options, success, error): void`**
Text recognition on Cloud - Much better results, but you need an active paid plan (Blaze Plan) and activate it on Google Cloud. Parameter are the same like getText

### Image labeling

#####  **`getLabel(img, options, success, error): void`**
Image Labeling on device

#####  **`getLabelCloud(img, options, success, error): void`**
Image Labeling on Cloud

### Face detection

### Barcode scanning

### Landmark recognition

### Custom model inference

## Usage

```javascript
window["MlKitPlugin"].getText(fileBuffer, {},
    (success) => {
        console.log("getText success", success);
    },
    (error) => {
        console.log("getText error", error);
});
```

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