← Back to NOTES 🌰 ← Effective JavaScript 🤿

← 아이템 52 - Array 생성자 대신 배열 리터럴을 사용하라

핵심 요약

• 라이브러리 설계는 어렵고 예술적이며 매우 중요한 작업
• 함수 시그니처(함수 이름, 파라미터 종류와 개수)의 일관성이 핵심 컨벤션
• 인자의 순서를 항상 동일하게 유지하는 것이 사용자 편의성 향상
• 다른 라이브러리와 컨벤션을 같게 하는 것도 좋은 방법
• 최고의 라이브러리는 문서를 자전거의 보조 바퀴처럼 취급함

자세한 내용

함수 시그니처란?

함수의 특징을 결정짓는 요소들을 의미하며, 자바스크립트에서의 함수 시그니처는 함수의 이름, 파라미터의 종류와 개수를 말한다.

핵심 컨벤션: 인자의 순서

사용자를 위해 항상 동일한 순서로 인자를 받는 편이 좋다. 다른 라이브러리와 순서를 같게 하는 것도 좋은 방법이다.

일관성의 중요성

혹은 사용자들이 알아차리지 못할 수 있다. 그렇다면 더 좋다! 최고의 라이브러리는 문서를 자전거의 보조 바퀴처럼 대한다.

사용자가 API의 패턴을 학습하고 나면, 문서 없이도 자연스럽게 사용할 수 있어야 한다.

예제 코드

// 일관된 인자 순서를 가진 API 예제
// 모든 메서드가 (selector, options) 순서를 따름
element.animate(selector, options);
element.fadeIn(selector, options);
element.slideDown(selector, options);

// 일관되지 않은 API (피해야 함)
element.animate(options, selector);  // 순서가 다름
element.fadeIn(selector, options);

메모 / 코멘트