API 매개변수를 객체로 묶자

김태성·2023년 8월 3일
0

API 매개변수를 객체로 묶었을 때의 장점을 정리해봤다.

export const getKeywordNews = async (memberKeywordId, pageParam, size ) => {} (before)
export const getKeywordNews = async ({memberKeywordId, pageParam, size} ) => {} (after)

이렇게 작성하면 아래와 같은 장점이 있다.

가독성: 객체 매개변수를 사용하면 함수 호출이 더 가독성 있을 수 있다. 특히, 여러 개의 선택적 매개변수가 있는 경우, 매개변수의 목적을 키 기반으로 쉽게 파악할 수 있다.

(❗️)매개변수 순서 변경에 대한 영향 최소화: 함수의 매개변수 순서가 바뀌더라도, 객체 매개변수를 사용하면 명시적으로 키를 지정해주기 때문에 영향이 최소화된다.

(❗️❗️)선택적 매개변수 지원: 객체 매개변수를 사용하면 매개변수를 선택적으로 만들 수 있다. 각 매개변수에 기본 값이 있거나, 필요한 매개변수만 전달할 수 있으므로 함수를 더 유연하게 사용할 수 있다.

(❗️❗️)코드 자동 완성 및 도움말: 객체 매개변수를 사용하면 IDE에서 해당 매개변수의 필드를 자동 완성하고 도움말을 표시하는 기능을 더 쉽게 사용할 수 있다.

profile
@flip_404

1개의 댓글

comment-user-thumbnail
2023년 8월 3일

잘 봤습니다. 좋은 글 감사합니다.

답글 달기