Referência da API

Ao invés de modificar o Date.prototype nativo, o Day.js empacota o objeto nativo Date em um objeto Dayjs.

O objeto Dayjs é imutável, ou seja, todas as operações da API que alteram o objeto Dayjs irão retornar uma nova instancia deste objeto.

Referência da API

Conversões

Construtor `dayjs(existing?: string | number | Date | Dayjs)`

Chamando este construtor sem parâmetros, será retornado um objeto Dayjs contendo a data e hora atual.

dayjs();

Day.js também converte outros formatos de data.

string ISO 8601

dayjs('2018-04-04T16:00:00.000Z');

Objeto `Date` nativo

dayjs(new Date(2018, 8, 18));

Unix Timestamp (milliseconds)

dayjs(1318781876406);

Unix Timestamp (seconds) `.unix(value: number)`

Returns a Dayjs from a Unix timestamp (seconds since the Unix Epoch)

dayjs.unix(1318781876);
dayjs.unix(1318781876.721);

Custom Parse Format

parse custom formats dayjs("12-25-1995", "MM-DD-YYYY") in plugin CustomParseFormat

Clonar `.clone() | dayjs(original: Dayjs)`

Retorna um objeto Dayjs clonado.

dayjs().clone();
dayjs(dayjs('2019-01-25')); // passando um objeto Dayjs para o construtor também irá cloná-lo

Validação `.isValid()`

Retorna um boolean indicando se a data do objeto Dayjs é válida.

dayjs().isValid();

Get and Set

Ano `.year()`

Retorna um number representando o ano do objeto Dayjs.

dayjs().year();

Mês `.month()`

Retorna um number representando o mês do objeto Dayjs.

dayjs().month();

Dia do Mês `.date()`

Retorna um number representando o dia do mês do objeto Dayjs.

dayjs().date();

Dia da Semana `.day()`

Retorna um number representando o dia da semana do objeto Dayjs.

dayjs().day();

Hora `.hour()`

Retorna um number representando a hora do objeto Dayjs.

dayjs().hour();

Minuto `.minute()`

Retorna um number representando os minutos do objeto Dayjs.

dayjs().minute();

Segundo `.second()`

Retorna um number representando os segundos do objeto Dayjs.

dayjs().second();

Milissegundo `.millisecond()`

Retorna um number representando os milissegundos do objeto Dayjs.

dayjs().millisecond();

Set `.set(unit: string, value: number)`

Retorna um Dayjs com as mudanças aplicadas.

dayjs().set('date', 1);
dayjs().set('month', 3); // April
dayjs().set('second', 30);

Lista de todas as unidades disponíveis

Unidade	Shorthand	Descrição
`date`		Data do Mês
`day`	`d`	Dia da Semana (Domingo como 0, Sábado como 6)
`month`	`M`	Mês
`year`	`y`	Ano
`hour`	`h`	Hora
`minute`	`m`	Minuto
`second`	`s`	Segundo
`millisecond`	`ms`	Milissegundo

Manipulando

Um objeto Dayjs pode ser manipulado de várias maneiras.

dayjs('2019-01-25')
  .add(1, 'day')
  .subtract(1, 'year').toString(); // Fri, 26 Jan 2018 00:00:00 GMT

Adicionar `.add(value: number, unit: string)`

Retorna um objeto Dayjs clonado com a quantidade especificada de dias adicionados.

dayjs().add(7, 'day');

Subtrair `.subtract(value: number, unit: string)`

Retorna um objeto Dayjs clonado com a quantidade especificada de dias subtraídos.

dayjs().subtract(7, 'year');

Início do Tempo `.startOf(unit: string)`

Retorna um objeto Dayjs clonado definido com o começo da unidade de tempo especificada.

dayjs().startOf('week');

Fim do Tempo `.endOf(unit: string)`

Retorna um objeto Dayjs clonado definido com o fim da unidade de tempo especificada.

dayjs().endOf('month');

Exibindo

Formatação `.format(stringWithTokens: string)`

Retorna uma string com um objeto Dayjs contendo a data formatada. Para escapar caracteres, envolva-os entre colchetes ou chaves (por exemplo: [G] {um}).

dayjs().format(); // current date in ISO6801, without fraction seconds e.g. '2020-04-02T08:02:17-05:00'

dayjs('2019-01-25').format('{YYYY} MM-DDTHH:mm:ssZ[Z]'); // '{2019} 01-25T00:00:00-02:00Z'

dayjs('2019-01-25').format('DD/MM/YYYY'); // '25/01/2019'

Lista com todos os formatos disponíveis

Formato	Saída	Descrição
`YY`	18	Ano, com 2 dígitos
`YYYY`	2018	Ano, com 4 dígitos
`M`	1-12	Mês (começa em 1)
`MM`	01-12	Mês, com 2 dígitos
`MMM`	Jan-Dec	Nome do mês abreviado
`MMMM`	January-December	Nome do mês completo
`D`	1-31	Dia do mês
`DD`	01-31	Dia do mês, com 2 dígitos
`d`	0-6	Dia da semana (Domingo = 0)
`dd`	Su-Sa	The min name of the day of the week
`ddd`	Sun-Sat	The short name of the day of the week
`dddd`	Sunday-Saturday	Nome do dia da semana
`H`	0-23	Hora
`HH`	00-23	Hora, com 2 dígitos
`h`	1-12	Hora (formato de 12 horas)
`hh`	01-12	Hora, com 2 dígitos (formato de 12 horas)
`m`	0-59	Minuto
`mm`	00-59	Minuto, com 2 dígitos
`s`	0-59	Segundo
`ss`	00-59	Segundo, com 2 dígitos
`SSS`	000-999	Milisegundo, com 3 dígitos
`Z`	+5:00	Diferença do fuso horário UTC
`ZZ`	+0500	Diferença do fuso horário UTC, com 2 dígitos
`A`	AM PM
`a`	am pm

Mais formatos disponíveis Q Do k kk X x ... no plugin AdvancedFormat

Diferença `.diff(compared: Dayjs, unit: string (padrão: 'milliseconds'), float?: boolean)`

Retorna um number indicando a diferença entre dois objetos Dayjs na unidade especificada.

const date1 = dayjs('2019-01-25');
const date2 = dayjs('2018-06-05');
date1.diff(date2); // 20214000000
date1.diff(date2, 'month'); // 7
date1.diff(date2, 'month', true); // 7.645161290322581
date1.diff(date2, 'day'); // 233

Unix Timestamp (milissegundos) `.valueOf()`

Retorna um number em milissegundos desde a Unix Epoch para o objeto Dayjs.

dayjs('2019-01-25').valueOf(); // 1548381600000

Unix Timestamp (segundos) `.unix()`

Retorna um number em segundos desde a Unix Epoch para o objeto Dayjs.

dayjs('2019-01-25').unix(); // 1548381600

Dias no Mês `.daysInMonth()`

Retorna um number em contendo o número de dias no mês do objeto Dayjs.

dayjs('2019-01-25').daysInMonth(); // 31

Como objeto `Date` do Javascript `.toDate()`

Retorna uma cópia do objeto nativo Date convertido de um objeto Dayjs.

dayjs('2019-01-25').toDate();

Como Array `.toArray()`

Retorna um array que espelha os parâmetros de um new Date().

dayjs('2019-01-25').toArray(); // [ 2019, 0, 25, 0, 0, 0, 0 ]

Como JSON `.toJSON()`

Retorna o objeto Dayjs formatado em uma string ISO8601.

dayjs('2019-01-25').toJSON(); // '2019-01-25T02:00:00.000Z'

Como uma string ISO 8601 `.toISOString()`

Retorna o objeto Dayjs formatado em uma string ISO8601.

dayjs('2019-01-25').toISOString(); // '2019-01-25T02:00:00.000Z'

Como Objeto `.toObject()`

Retorna um object com as propriedades da data.

dayjs('2019-01-25').toObject();
/* { years: 2019,
     months: 0,
     date: 25,
     hours: 0,
     minutes: 0,
     seconds: 0,
     milliseconds: 0 } */

Como String `.toString()`

Retorna uma representação em string da data.

dayjs('2019-01-25').toString(); // 'Fri, 25 Jan 2019 02:00:00 GMT'

Consulta

Antes `.isBefore(compared: Dayjs, unit?: string)`]

Retorna um boolean indicando se a data do objeto Dayjs é antes da data fornecida de em outro objeto Dayjs.

dayjs().isBefore(dayjs()); // false
dayjs().isBefore(dayjs(), 'year'); // false

Igual `.isSame(compared: Dayjs, unit?: string)`]

Retorna um boolean indicando se a data do objeto Dayjs é a mesma data fornecida de em outro objeto Dayjs.

dayjs().isSame(dayjs()); // true
dayjs().isSame(dayjs(), 'year'); // true

Depois `.isAfter(compared: Dayjs, unit?: string)`]

Retorna um boolean indicando se a data do objeto Dayjs é depois da data fornecida de em outro objeto Dayjs.

dayjs().isAfter(dayjs()); // false
dayjs().isAfter(dayjs(), 'year'); // false

É um objeto `Dayjs` `.isDayjs()`

Retorna um boolean indicando se a variável é um objeto Dayjs ou não.

dayjs.isDayjs(dayjs()); // true
dayjs.isDayjs(new Date()); // false

The operator instanceof works equally well:

dayjs() instanceof dayjs // true

Plugin APIs

RelativeTime

.from .to .fromNow .toNow para obter o tempo relativo

plugin RelativeTime

IsLeapYear

.isLeapYear para obter um ano bissexto ou não

plugin IsLeapYear

WeekOfYear

.week para obter a semana do ano

plugin WeekOfYear

IsSameOrAfter

.isSameOrAfter to check if a date is same of after another date

plugin IsSameOrAfter

IsSameOrBefore

.isSameOrBefore to check if a date is same of before another date.

plugin IsSameOrBefore

IsBetween

.isBetween para verificar se uma data está entre duas outras datas

plugin IsBetween

QuarterOfYear

.quarter to get quarter of the year

plugin QuarterOfYear

Files

API-reference.md

Latest commit

History

API-reference.md

File metadata and controls

Referência da API

Conversões

Construtor dayjs(existing?: string | number | Date | Dayjs)

string ISO 8601

Objeto Date nativo

Unix Timestamp (milliseconds)

Unix Timestamp (seconds) .unix(value: number)

Custom Parse Format

Clonar .clone() | dayjs(original: Dayjs)

Validação .isValid()

Get and Set

Ano .year()

Mês .month()

Dia do Mês .date()

Dia da Semana .day()

Hora .hour()

Minuto .minute()

Segundo .second()

Milissegundo .millisecond()

Set .set(unit: string, value: number)