js-avatar
v1.0.0
Published
A package to generate avatars based on email and name.
Maintainers
Readme
js-avatar
A npm package to get avatars based on email and name.
Installation
$ npm install js-avatarDependencies
Runtime
- Node 10+
Development
- md5
Usage
// CommonJS
const { getAvatar } = require('js-avatar')
getAvatar(email) // [email protected]
// returns
// {
// image: 'https://s.gravatar.com/avatar/67135a14d3ac4f1369633dd006d6efec3b?s=128',
// initials: 'https://ui-avatars.com/api/?name=Shahbaz+Alam&background=random&size=128'
// }
getAvatar(email, name) // [email protected], Full Name
// returns
// {
// image: 'https://s.gravatar.com/avatar/67135a14d3ac4f1369633dd006d6efec3b?s=128',
// initials: 'https://ui-avatars.com/api/?name=Full+Name&background=random&size=128'
// }
getAvatar(email, name, size) // [email protected], Full Name, 200
// returns
// {
// image: 'https://s.gravatar.com/avatar/67135a14d3ac4f1369633dd006d6efec3b?s=200',
// initials: 'https://ui-avatars.com/api/?name=Full+Name&background=random&size=200'
// }