0.1.1 • Published 4 years ago

@ardyfeb/identicon v0.1.1

Weekly downloads
2
License
MIT
Repository
github
Last release
4 years ago

Identicon

Blazing fast identicon generator for nodejs based on identicon-rs. What is Identicon ? https://en.wikipedia.org/wiki/Identicon

Installation

Before installing this package make sure you have rust installed, read https://www.rust-lang.org/tools/install

NPM:

$ npm install @ardyfeb/identicon

Yarn:

$ yarn add @ardyfeb/identicon

Usage

const identicon = require('@ardyfeb/identicon')

const iconBuffer = identicon.generate("some magic words", {
  border: 50,
  background: [000, 000, 000],
  // other options
})

Above example is only generating nodejs buffer, to generate to file

identicon.generateToFile("some magic words", "icon.png", {
  border: 50,
  background: [000, 000, 000],
  // other options
})

API

  • generate(<magic word>, <options>): Buffer
  • generateToFile(<magic word>, <file name>, <options>): void

see available options here

Available Options

export interface Options {
  border?: number,
  size?: number,
  scale?: number,
  background?: number[],
  format?: 'png' | 'jpeg',
}