📦modules

modules 폴더는 애플리케이션에서 사용하는 다양한 모듈에서 필요한 type을 지정한 곳입니다. init에는 declares(모듈 선언), react, react-query 모듈에 대한 타입 정의가 있습니다.

➡️ Declares

➡️ React

➡️ React-Query

---

1. Declares

TypeScript에서 module로 직접 선언한 파일들이 있는 곳입니다.

주로 외부 라이브러리나 프레임워크와 상호 작용하기 위한 타입 선언 파일들을 포함하는 모듈입니다. 이 모듈은 TypeScript로 작성된 외부 패키지의 타입 정보를 정의하여 코드 힌트와 유효성 검사를 개선하는 데 사용됩니다.

예를 들어 .png와 같은 이미지확장자는 일반적으로 타입 정보를 갖고 있지 않으므로 TypeScript가 해당 파일을 모듈로 인식하지 못하고 오류를 발생시킵니다.

// ❌ Cannot find module '../../../public/images/new_og.png' 
// or its corresponding type declarations. ❌
import New from '../../../public/images/new_og.png';

하지만 .png확장자를 module로 선언 후

//image.d.ts
declare module '*.png';

TypeScript가 선언된 파일을 컴파일할 수 있도록 경로를 추가하면, TypeScript는 해당 파일들을 모듈로 취급하고 타입 검사를 진행하지 않습니다.

// tsconfig.json
{
  // ...
  "include": ["next-env.d.ts", "app.d.ts", "**/*.ts", "**/*.tsx", "**/*.d.ts"],
  "exclude": ["node_modules", "./public/mockServiceWorker.js"]
}

Tokplate에는 이미지 확장자들을 모듈로 선언하지 않았는데 왜 타입에러가 발생하지 않나요? next-env.d.ts에서 next/image-types/global을 참조하고 있기 때문입니다.

// next-env.d.ts
 <reference types="next/image-types/global" />

---

2. React

1. PropsOf 타입 스크립트에서 컴포넌트의 프롭스 타입을 추출하는 유틸리티입니다. 이 유틸리티를 사용하면 컴포넌트의 프롭스 타입을 추론하여 해당 프롭스를 다른 곳에서 사용할 수 있습니다.

type ButtonProps = { color: string; onClick: () => void; };
const Button:React.FC<ButtonProps> = (props) => { // ... };

type ButtonPropsExtracted = PropsOf<typeof Button>; // ButtonProps

---

3. React-Query

아래의 네 가지 제네릭 타입은 React Query 라이브러리를 사용하여 효율적으로 쿼리 기능을 구현하기 위해 사용되는 Custom hooks에서 사용되는 타입입니다.

UseQueryParams

useQuery 훅에서 사용됩니다.

UseInfiniteQueryParams

UseMutationParams

WrapVariables

해당 섹션에서는 UseQueryParams Type에 대한 설명만 명시되어 있습니다. 해당 타입만 이해해도 다른 제네릭 타입들도 충분히 이해하실 수 있을 것 입니다.

UseQueryParams

Tokplate 에서는

react-query의 UseQueryOptions와 axios의 AxiosError를 조합하여, useQuery를 더 편리하게 활용하기 위해 useGetExampleListQuery라는 커스텀 훅을 개발하여 사용하고 있습니다.

useQuery(key, function, options) 
          ↑      ↑         ↑
        쿼리키  api호출함수  쿼리옵션

api 호출 함수에서는 아래의 두 가지 매개변수가 필요합니다. 또한 각 매개변수에 대한 타입도 명시해 주어야 합니다.

• variables api 요청에 필요한 매개변수 (parameters)

• options useQuery에서 제공하는 options e.g) enabled, staleTime, onSuccess, onError...

 useQuery(
    queryKey,
    () => exampleApi.getList(params?.variables),
    params?.options, 
  );

useQuery를 활용하여 useGetExampleListQuery 라는 Custom Hook을 적용해보겠습니다.

ExampleApi

ExampleApi 의 getList 함수는 GetExampleDto type의 매개변수를 받아 ExampleModel[] 의 데이터를 리턴하는 async function입니다.

(property) ExampleApi.getList: (params?: GetExampleDto) => Promise<ExampleModel[]>

UseQueryParams 적용 전

UseQueryParams 적용 후

제네릭 타입을 활용하여 커스텀 훅의 타입 정의를 명확하게 표현하고, 이를 통해 유지보수성이 높은 코드를 구현할 수 있게 되었습니다.

이 섹션에서 정의된 타입들은 보통 실무에서 직접 수정하거나 추가할 필요가 거의 없을 것입니다. 그러나 이러한 타입들을 이해하면 문제 대응이 신속해지며, 다른 부분에서도 유용하게 활용할 수 있으므로, 한 번 정확하게 이해하시고 계속해서 활용하시는 것을 권장합니다.