Skip to content
This repository was archived by the owner on Feb 12, 2026. It is now read-only.

Latest commit

History

8 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

face-plus-plus

NPM VersionNPM Downloads

face-plus-plus is a node client for the faceplusplus.com(CN) API

Version: 0.0.3

Installation via npm

$ npm install face-plus-plus

Require

varfpp=require('face-plus-plus');

Configure face-plus-plus

(Required) Set your API Key

fpp.setApiKey('YOUR_API_KEY');

(Required) Set your API Secret

fpp.setApiSecret('YOUR_API_SECRET');

(Optional) Set the server (default: 'us')

fpp.setServer('cn');

(Optional) Set the API version (default: '2')

fpp.setVersion('2');

(Optional) Set request options

varoptions={timeout: 3000,headers: {connection: "keep-alive"}};fpp.setOptions(options);

Examples

GET request (pass an image at a URL)

varfpp=require('face-plus-plus');fpp.setApiKey('YOUR_API_KEY');fpp.setApiSecret('YOUR_API_SECRET');varparameters={url: 'http://example.com/a.jpg',attribute: 'gender,age'};fpp.get('detection/detect',parameters,function(err,res){console.log(res);});

POST request (pass an image from the local file system)

varfpp=require('face-plus-plus'),fs=require('fs');fpp.setApiKey('YOUR_API_KEY');fpp.setApiSecret('YOUR_API_SECRET');varparameters={attribute: 'gender,age',img : {value: fs.readFileSync('./a.jpg'),meta: {filename:'a.jpg'}}};fpp.post('detection/detect',parameters,function(err,res){console.log(res);});

License

MIT

About

Node client for faceplusplus.com API

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages