Skip to content

Latest commit

 

History

History
403 lines (280 loc) · 12.2 KB

API-reference.md

File metadata and controls

403 lines (280 loc) · 12.2 KB

API Reference

Day.js는 네이티브 Date.prototype을 수정하는 대신 Dayjs 오브젝트인 Date 오브젝트 래퍼를 생성합니다.

Dayjs 오브젝트는 변경이 불가능(immutable)합니다. 즉, 모든 API 작업은 새로운 Dayjs 오브젝트를 반환합니다.

Parsing

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

매개 변수없이 호출하면 현재 날짜와 시간을 가진 새로운 Dayjs 오브젝트가 반환됩니다.

dayjs();

Day.js는 다른 날짜 형식도 구분 분석합니다.

ISO 8601 string

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

Unix Timestamp (milliseconds since the Unix Epoch - Jan 1 1970, 12AM UTC)

dayjs(1318781876406);

Native Javascript Date object

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

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

Dayjs 클론 오브젝트를 반환합니다.

dayjs().clone();
dayjs(dayjs('2019-01-25')); // passing a Dayjs object to a constructor will also clone it

Validation .isValid()

Dayjs 날짜가 유효한지 확인합니다. 반환 타입은 boolean 입니다.

dayjs().isValid();

Get and Set

Year .year()

Dayjs에서 연도 가져옵니다. 반환 타입은 number 입니다.

dayjs().year();

Month .month()

Dayjs에서 달을 가져옵니다. 반환 타입은 number 입니다.

dayjs().month();

Day of the Month .date()

Dayjs에서 날짜를 가져옵니다. 반환 타입은 number 입니다.

dayjs().date();

Day of the Week .day()

Dayjs에서 요일을 가져옵니다. 반환 타입은 number 입니다.

dayjs().day();

Hour .hour()

Dayjs에서 시를 가져옵니다. 반환 타입은 number 입니다.

dayjs().hour();

Minute .minute()

Dayjs에서 분을 가져옵니다. 반환 타입은 number 입니다.

dayjs().minute();

Second .second()

Dayjs에서 초를 가져옵니다. 반환 타입은 number 입니다.

dayjs().second();

Millisecond .millisecond()

Dayjs에서 밀리 초를 가져옵니다. 반환 타입은 number 입니다.

dayjs().millisecond();

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

변경 사항이 적용된 Dayjs를 반환합니다.

dayjs('2000-10-25')
  .set('month', 3)
  .set('year', 2020).toString(); // Sat, 25 Apr 2020 00:00:00 GMT

Manipulating

Dayjs 오브젝트는 여러 방법으로 처리할 수 있습니다.

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

Add .add(value: number, unit: string)

지정한 시간을 더한 Dayjs 오브젝트 복제본을 반환합니다.

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

Subtract .subtract(value: number, unit: string)

지정한 시간을 뺀 Dayjs 오브젝트 복제본을 반환합니다.

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

Start of Time .startOf(unit: string)

특정 시간 단위의 시작 시점에 대한 시간을 Dayjs 오브젝트 복제본으로 반환합니다.

dayjs().startOf('week');

End of Time .endOf(unit: string)

특정 시간 단위의 끝나는 시점에 대한 시간을 Dayjs 오브젝트 복제본으로 반환힙니다.

dayjs().endOf('month');

Displaying

Format .format(stringWithTokens: string)

Dayjs 오브젝트 시간을 기본 형식으로 출력합니다. 반환 형식은 string 입니다. 예외하고 싶은 문자일 경우, 대괄호나 중괄호를 사용하여 묶으면됩니다. (예, [G] {um})

dayjs().format(); // 분과 초가 없는 ISO5801 형식의 현재 시간을 나타냅니다. 예: '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'

List of all available formats

Format Output Description
YY 18 두 자리로 된 연도
YYYY 2018 네 자리로 된 연도
M 1-12 달, 1부터 시작
MM 01-12 달, 두 자리로 표현
MMM Jan-Dec 월 이름 약어
MMMM January-December 월 이름
D 1-31
DD 01-31 일, 두 자리로 표현
d 0-6 요일, 일요일은 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 요일 이름
H 0-23 시간
HH 00-23 시간, 두 자리로 표현
h 1-12 시간, 12시간
hh 01-12 시간, 12시간, 두 자리로 표현
m 0-59
mm 00-59 분, 두 자리로 표현
s 0-59
ss 00-59 초, 두 자리로 표현
SSS 000-999 밀리 초, 3자리로 표현
Z +5:00 UTC로부터 추가된 시간
ZZ +0500 UTC로부터 추가된 시간, 두자리로 표현
A AM PM
a am pm
  • 플러그인 AdvancedFormat 을 사용하면 더 많은 형식(Q Do k kk X x ...)을 사용할 수 있습니다.

Difference .diff(compared: Dayjs, unit: string (default: 'milliseconds'), float?: boolean)

Dayjs 오브젝트 차이를 지정한 단위로 가져옵니다. 반환 타입은 number 입니다.

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

Unix Timestamp (milliseconds) .valueOf()

Dayjs에 대한 Unix Epoch 이후의 밀리 초 시간을 가져옵니다. 반환 타입은 number 입니다.

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

Unix Timestamp (seconds) .unix()

Dayjs에 대한 Unix Epoch 이후의 초 시간을 가져옵니다. 반환 타입은 number 입니다.

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

Days in the Month .daysInMonth()

Dayjs에서 표기하는 달에서 일수를 가져옵니다. 반환 타입은 number 입니다.

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

As Javascript Date .toDate()

Dayjs 오브젝트에서 파싱된 네이티브 Date 오브젝트 복사본을 반환합니다.

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

As Array .toArray()

새로운 Date()로부터 매개변수로 입력한 날짜를 가져옵니다. 반환 타입은 array 입니다.

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

As JSON .toJSON()

ISO8601에 대한 형식으로 Dayjs를 출력합니다. 반환 타입은 string 입니다.

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

As ISO 8601 String .toISOString()

ISO8601에 대한 형식으로 Dayjs를 출력합니다. 반환 타입은 string 입니다.

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

As Object .toObject()

날짜 속성을 가진 object 타입 값으로 반환합니다.

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

As String .toString()

날짜를 string 타입 값으로 반환합니다.

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

Query

Is Before .isBefore(compared: Dayjs)

Dayjs가 다른 Dayjs보다 앞선 시점인지를 확인합니다. 반환 타입은 boolean 입니다.

dayjs().isBefore(dayjs()); // false

Is Same .isSame(compared: Dayjs)

Dayjs가 다른 Dayjs과 동일한 시점인지를 확인합니다. 반환 타입은 boolean 입니다.

dayjs().isSame(dayjs()); // true

Is After .isAfter(compared: Dayjs)

Dayjs가 다른 Dayjs보다 뒷선 시점인지를 확인합니다. 반환 타입은 boolean 입니다.

dayjs().isAfter(dayjs()); // false

Is Leap Year .isLeapYear()

[DEPRECATED] in 1.7.0, use IsLeapYear plugin instead

Dayjs 값이 윤년인지를 확인합니다. 반환 타입은 boolean 입니다.

dayjs('2000-01-01').isLeapYear(); // true

Plugin APIs

RelativeTime

.from .to .fromNow .toNow에 대한 상대 시간을 가져옵니다.

플러그인 RelativeTime

IsLeapYear

.isLeapYear to get is a leap year or not

plugin IsLeapYear