npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

faceplusplus-sdk

v1.2.0

Published

A JavaScript SDK / API client for common FPP APIs

Downloads

9

Readme

FacePlusPlus API client

A JavaScript SDK / API client for common FPP APIs, for example:

Usage

npm i faceplusplus-sdk

import { bHumanBodyDetectAPI } from "faceplusplus-sdk";

...

const result = await bHumanBodyDetectAPI({
  return_attributes: 'gender,upper_body_cloth,lower_body_cloth',
  image_file: '~/myimage.jpg', // see image_file note below!
})

Auth credentials

REQUIRED!

You can make a free account to get your API key and secret.

If credentials are not set correctly, the api client will throw an Error.

Option 1: creds-fpp.json

Create a creds-fpp.json file in the app's process.cwd() (root):

{
  "api_key": "...",
  "api_secret": "..."
}

Option 2: configCreds

Import configCreds function to set your auth credentials:

import { configCreds } from "faceplusplus-sdk";
...
configCreds({
  api_key: "...",
  api_secret: "..."
});

QPS rate throttle

OPTIONAL!

You can configure a basic throttle to help maintain the QPS rate limits of your account. Import configQPS function to set your throttle delay times:

import { configQPS } from "faceplusplus-sdk";
...
configQPS({
  beforeCallDelaySeconds: 0, // default
  afterCallDelaySeconds: 0, // default
});
  • beforeCallDelaySeconds: Before the API call is made, start this timer delay.
    • Effective timer delay: beforeCallDelaySeconds - API_CALL_DURATION
  • afterCallDelaySeconds: After the API call is made, start this timer delay.
    • Effective timer delay: afterCallDelaySeconds + API_CALL_DURATION

Note: API call will only return when all timers have expired.

APIs

More info about face_token.

Input image files, eg. for image_file, etc

Please use the peer dependency formdata-node / file-from-path, for example:

import { anyAPIExample } from "faceplusplus-sdk";
import { fileFromPath } from "formdata-node/file-from-path";
...
const r = await anyAPIExample({
  image_file: await fileFromPath(pathToImageFile),
});

Tip: How to write a base64 image result to a file (NodeJS)

A simple example:

import fs from "fs";

function saveB64ImageToFile(base64Data, filepath) {
  const buffer = Buffer.from(base64Data, "base64");
  fs.writeFileSync(filepath, buffer);
}

CLI scripts

If you git clone this repo, there are npm scripts you can run that provide a command line interface to the library API client. See package.json for a list of scripts available.

Notebooks

If you git clone this repo, there are VS restbook notebooks you can run that provide a GUI to the API raw endpoints. See /notebooks for a list of available restbooks.