Generate default avatars based on user's name without a sweat
npm install named-avatar-generator --save
const AvatarGenerator = require("named-avatar-generator");
AvatarGenerator.generate({ name: "Ameer Jhan", size: 64 }).then(avatar => {
AvatarGenerator.writeAvatar(avatar, "./default-avatar.jpg");
});
The above code will generate an awesome default avatar as shown below
AvatarGenerator.generate(options).then(avatar => {
...
});
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 |
This can be used to write the image to the filesystem
AvatarGenerator.writeAvatar(avatar, path)
.then(() => {
console.log(`Image written to ${path}`);
})
.catch(err => {
console.log(err);
});
This can be used to get the image as data URI
AvatarGenerator.getBase64(avatar, mime)
.then(dataURI => {
console.log(dataURI);
})
.catch(err => {
console.log(err);
});
This can be used to get the image as buffer
AvatarGenerator.getBuffer(avatar, mime)
.then(buffer => {
console.log(buffer);
})
.catch(err => {
console.log(err);
});
The supported MIME are
MIT © Ameer Jhan