DIL: 이펙티브 타입스크립트

스터디: 월간 CS, https://github.com/monthly-cs/2024-05-effective-typescript
작성일: 2024-06-04
작성자: dusunax

---

아이템 40: 함수 안으로 타입 단언문 감추기 Hide Unsafe Type Assertions in Well-Typed Functions

• 외부 타입 정의는 간단하지만, 함수 내부 로직이 복잡한 경우!
  • 내부에 타입 단언을 사용하고, 외부로 드러나는 타입 정의를 정확히 명시
  • 프로젝트에 타입 단언문이 드러나 있지 않도록 감추기

캐시 래퍼 함수

리액트는 useMemo가 있다.

• 함수 내부에 any가 많지만, cacheLast의 타입 정의에는 any가 없기 때문에, cacheLast를 호출하는 쪽에서는 any가 사용되었는지 알지 못한다.
  • any를 사용했지만, cacheLast를 사용하는 쪽에서는 타입 안전성을 유지함

declare function cacheLast<T extends Function>(fn: T): T;
declare function shallowEqual(a: any, b: any): boolean;

// 구현체
// 원본 함수가 객체처럼 속성 값을 가지고 있다면 타입이 달라진다
// (연속적으로 호출할 때 this 값이 동일한 지 체크하지 않음)
function cacheLast<T extends Function>(fn: T): T {
  let lastArgs: any[] | null = null;
  let lastResult: any;

  return function (...args: any[]) {
    if (!lastArgs || !shallowEqual(lastArgs, args)) {
      lastResult = fn(...args); // 마지막 함수 반환값
      lastArgs = args; // 마지막 매개변수
    }
    return lastResult;
  }; as unknown as T;
}

// this를 추가한 경우
function cacheLastWithThis<T extends Function>(fn: T): T {
  let lastArgs: any[] | null = null;
  let lastResult: any;
  let lastContext: any; // lastContext 변수를 추가하여 마지막 호출 시의 this 값을 저장

  return function (this: any, ...args: any[]) {
    if (!lastArgs || lastContext !== this || !shallowEqual(lastArgs, args)) {
      lastResult = fn.apply(this, args); // 마지막 함수 반환값
      lastArgs = args; // 마지막 매개변수
      lastContext = this; // 마지막 this 값
    }
    return lastResult;
  } as unknown as T;
}

shallowObjectEqual

• 객체가 같은 지 체크하기 위해
• 아래의 (b as any)[key] 단언은 안전하다.
  • key in b(키가 객체 b에 있는지)를 먼저 확인했기 때문

function shallowObjectEqual<T extends object>(a: T, b: T): boolean {
  // a, b: 비교할 객체
  for (const [key, value] of Object.entries(a)) {
    // 객체 `a`의 모든 키 값 쌍을 순회
    if (!(key in b) || value !== (b as any)[key]) {
      // 객체 b에, 현재 키가 존재하는 지 확인.
      // 키가 없거나, 객체 a의 값 value과 다르다면? false를 반환한다.
      return false;
    }
  }
  return Object.keys(a).length === Object.keys(b).length;
  // 두 객체의 키 갯수가 같은 지 체크
  // 모든 키와 값이 일치하고, 키 개수가 동일하다 -> true (얕은 비교가 참)
}

Things to Remember

• Sometimes unsafe type assertions and any types are necessary or expedient. When you need to use one, hide it inside a function with a correct signature.
  • 때때로 불가피하거나 편의를 위해 any를 사용해야 하는 경우가 있다. 이 때 any를 올바른 시그니처의 함수 안에 숨기자. 함수 바깥의 타입 안정성 유지
• Don't compromise a function's type signature to fix type errors in the implementation.
  • 타입 에러를 수정하기 위해, 함수의 타입 시그니처를 바꾸지 말자. (함수의 타입 시그니처를 유지하면서 타입 오류를 해결하기)
• Make sure you explain why your type assertions are valid, and unit test your code thoroughly.
  • 타입 단언에 대한 설명과 유닛 테스트 필요