npm

nome-aleatorio

0.1.0 • Public • Published

nome-aleatorio

Obter um nome (português) aleatório.

Instalação

Para instalá-lo, faça:

$ npm install --save nome-aleatorio

Uso

Importe-o com:

var nomeAleatorio = require("nome-aleatorio");

Veja abaixo alguns exemplos:

nomeAleatorio(); //=> "Lavínia"
nomeAleatorio({accents: false}); //=> "Lavinia"
nomeAleatorio({accents: lowercase: true}); //=> "lavinia"

// Por letra.
nomeAleatorio({letter: "h"}); //=> "Heloísa"
nomeAleatorio({letter: "h", accents: false}); //=> "Heloisa"
nomeAleatorio({letter: "h", accents: false, lowercase: true}); //=> "heloisa"

nomeAleatorio([opcoes])

Onde opcoes deve ser um objeto.

Por padrão ele é:

{ letter: undefined,
  lowecase: false,
  accents: true }

Onde:

  • letter (string) ― Retornar nomes com determinada inicial.
  • lowercase (boolean) ― Retornar nomes em caixa baixa.
  • accents (boolean) ― Retornar nomes sem acentos.

Licença

MIT

Readme

Keywords

none

Package Sidebar

Install

npm i nome-aleatorio

Weekly Downloads

0

Version

0.1.0

License

MIT

Last publish

Collaborators

  • theuves