dia-da-semana v0.2.1

dia-da-semana

Obter o nome ou o número de um dia da semana.

Instalação

$ npm install --save dia-da-semana

Uso

var diaDaSemana = require("dia-da-semana");

Veja a sintaxe:

diaDaSemana([dia[, opções]])

Use diaDaSemana() (sem parâmetros) para obter o número do dia da semana atual.

Parâmetros

dia:

Tipo: String (cadeia de caracteres) ou Number (número).

Especifica o nome ou número (inteiro maior que 0 e menor que 8) de um dia da semana (exemplo: segunda, segunda-feira, seg ou 2). Veja alguns exemplos abaixo:

diaDaSemana("segunda"); // retorna 2
diaDaSemana("segunda-feira"); // retorna 2
diaDaSemana("seg"); // retorna 2
diaDaSemana(2); // retorna "segunda"

opções:

Tipo: Object (objeto).

Ambas as opções abaixo, são do tipo Boolean (booleano) e com valor false (falso) por padrão.

• abreviado - se for true (verdadeiro) retornará a abreviatura do nome do dia
• feira - se for true adicionará -feira no final do nome do dia (com exceção de domingo e sábado)

Alguns exemplos de uso:

diaDaSemana("segunda", {abreviado: true}); // retorna "seg"
diaDaSemana("segunda-feira", {abreviado: true}); // retorna "seg"
diaDaSemana(2, {abreviado: true}); // retorna "seg"
diaDaSemana("segunda", {feira: true}); // retorna "segunda-feira"
diaDaSemana(2, {feira: true}); // retorna "segunda-feira"

Licença

MIT