# get-face

> use wasm opencv.js to get face!

Latest version **1.0.2** (published 2020-08-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install get-face
pnpm add get-face
yarn add get-face
bun add get-face
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2020-08-14 |
| First published | 2020-06-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 8.8 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | zy445566 |
| Maintainers | zy445566 |
| Keywords | opencv, face |

## Links

- npm: https://www.npmjs.com/package/get-face
- Repository: https://github.com/zy445566/get-face
- Homepage: https://github.com/zy445566/get-face#readme
- Issues: https://github.com/zy445566/get-face/issues
- npm.io page: https://npm.io/package/get-face

## Dependencies (2)

- [jimp](https://npm.io/package/jimp.md) ^0.12.1
- [@types/node](https://npm.io/package/@types/node.md) ^14.0.10

## Recent versions

- 1.0.2 (latest) — 2020-08-14
- 1.0.1 — 2020-06-04
- 1.0.0 — 2020-06-04

## README

# get-face
use wasm opencv.js to get face!

# use
```sh
npm i get-face
```

# example
```js
const getFace = require('get-face');
const fs = require('fs');
const faceImgBufList = await getFace.getFace(fs.readFileSync('./imgInput.jpg'),'image/jpeg');
for(let i=0;i<faceImgBufList.length;i++) {
    fs.writeFileSync(`./imgOnput${i}.jpeg`,faceImgBufList[i]);
}
```
## imgInput.jpg
![imgInput.jpg](https://raw.githubusercontent.com/zy445566/get-face/master/imgInput.jpg)

## imgOnput0.jpeg
![imgOnput0.jpeg](https://raw.githubusercontent.com/zy445566/get-face/master/imgOnput0.jpeg)

# API
## Function
####  getFace @return Promise<Array<Buffer>> (face photo's buffer )
|ParamName |Must|Type|Default|Remark|
|:----    |:---|:----- |:----- |-----   |
|srcBuffer |yes  |Buffer |  / | photo's buffer  |
|mime |no  |string |  "image/jpeg"  |alltype: "image/png","image/jpeg","image/bmp" |
|top |no  |number |  0   |   |
|right |no  |number |  0   |   |
|bottom |no  |number |  0   |   |
|left |no  |number |  0   |   |

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