项目作者: ameerthehacker

项目描述 :
Generate avatars with first letter of user's first and last name :camera:
高级语言: JavaScript
项目地址: git://github.com/ameerthehacker/better-default-avatar.git
创建时间: 2018-03-31T13:35:42Z
项目社区:https://github.com/ameerthehacker/better-default-avatar

开源协议:MIT License

下载


Better Default Avatar

Generate default avatars based on user’s name without a sweat

How to use :question:

  1. Install the library
  1. npm install named-avatar-generator --save
  1. Start creating avatars
  1. const AvatarGenerator = require("named-avatar-generator");
  2. AvatarGenerator.generate({ name: "Ameer Jhan", size: 64 }).then(avatar => {
  3. AvatarGenerator.writeAvatar(avatar, "./default-avatar.jpg");
  4. });

The above code will generate an awesome default avatar as shown below

Default Avatar

Available options

  1. AvatarGenerator.generate(options).then(avatar => {
  2. ...
  3. });
Option Description Default
name Full name of the user No default value
size Size of the avatar in pixels 40
bgColor Background color of the avatar A random beautiful color
font BM font path Sans with best font size

Utility Functions

Write avatar

This can be used to write the image to the filesystem

  1. AvatarGenerator.writeAvatar(avatar, path)
  2. .then(() => {
  3. console.log(`Image written to ${path}`);
  4. })
  5. .catch(err => {
  6. console.log(err);
  7. });

Get image as Data URI

This can be used to get the image as data URI

  1. AvatarGenerator.getBase64(avatar, mime)
  2. .then(dataURI => {
  3. console.log(dataURI);
  4. })
  5. .catch(err => {
  6. console.log(err);
  7. });

Get image as buffer

This can be used to get the image as buffer

  1. AvatarGenerator.getBuffer(avatar, mime)
  2. .then(buffer => {
  3. console.log(buffer);
  4. })
  5. .catch(err => {
  6. console.log(err);
  7. });

Available MIME

The supported MIME are

  • jpeg
  • png
  • bmp

License

MIT © Ameer Jhan