bukinoshita / tinyfaces

πŸ‘¦πŸΌπŸ‘¨πŸΎπŸ‘©πŸ» A JavaScript wrapper for TinyFaces API

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

tinyfaces Build Status

A JavaScript wrapper for TinyFaces API

Install

$ yarn add tinyfaces

Usage

const tinyfaces = require('tinyfaces')

tinyfaces().then(t => console.log(t))

/*
[{
  avatars: [ [Object], ...],
  avatars_origin: {
    facebook_profile_link: FB_URL,
    id: 862,
    name: 'Jakk Sheer'
  },
  first_name: 'Jakk',
  gender: 'male',
  last_name: 'Sheer'
}, ...]
*/

API

tinyfaces([options])

Type: object

Returns a promise

options

gender

Type: string
Default: returns both genders
Options: male / female

Tinyface gender

minQuality

Type: number
Options: 1, 2, 3, 4, 5, 6

Tinyface avatar quality β€” 1: low / 6: high

Rules

  • You can’t use any of our content next to any adult or discrimating content.
  • You should never use the real name of the person in the photo in your designs.
  • Never use a photo for fake testimonals.
  • This list of rules might grow in the future and should be checked regularly.

License

MIT Β© Bu Kinoshita

About

πŸ‘¦πŸΌπŸ‘¨πŸΎπŸ‘©πŸ» A JavaScript wrapper for TinyFaces API

License:MIT License


Languages

Language:JavaScript 100.0%