https://github.com/bukinoshita/tinyfaces

👦🏼👨🏾👩🏻 A JavaScript wrapper for TinyFaces API
https://github.com/bukinoshita/tinyfaces

api design face js nodejs sketch tinyfaces ui wrapper

Last synced: about 2 months ago
JSON representation

👦🏼👨🏾👩🏻 A JavaScript wrapper for TinyFaces API

• Host: GitHub
• URL: https://github.com/bukinoshita/tinyfaces
• Owner: bukinoshita
• License: mit
• Created: 2017-08-23T22:06:17.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-03T23:22:53.000Z (almost 2 years ago)
• Last Synced: 2024-10-10T16:08:00.535Z (2 months ago)
• Topics: api, design, face, js, nodejs, sketch, tinyfaces, ui, wrapper
• Language: JavaScript
• Homepage:
• Size: 226 KB
• Stars: 8
• Watchers: 3
• Forks: 1
• Open Issues: 15
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# tinyfaces [![Build Status](https://travis-ci.org/bukinoshita/tinyfaces.svg?branch=master)](https://travis-ci.org/bukinoshita/tinyfaces)

> A JavaScript wrapper for [TinyFaces](https://github.com/maximedegreve/TinyFaces) API



## Install

```bash

$ yarn add tinyfaces

```

## Usage

```js

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](https://bukinoshita.io)