nome-aleatorio
v0.1.0
Published
Obter um nome (português) aleatório.
Downloads
1
Readme
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