타입스크립트와 자바스크립트를 같은 프로젝트에서 사용하기

allowJs

---

TypeScript 컴파일러가 JavaScript 파일을 포함하여 JavaScript 파일을 허용하도록 설정할 수 있습니다.

타입스크립트에서 자바스크립트 파일을 import할 수 있게 됩니다.

// tsconfig.json

{
  "compilerOptions": {
    "allowJs": true,
  }
}

타입스크립트 파일 예시

import { init, exit } from "./myPackage.js";

@ts-check

---

TypeScript가 지원하는 주석중 하나이며 JavaScript 파일 내에서 TypeScript의 정적 타입 검사를 활용하도록 설정하는 데 사용됩니다.

자바스크립트 파일 예시

TypeScript 컴파일러는 @ts-check 주석 아래의 코드에 대해 타입 검사를 수행하고, 타입 오류를 찾아내어 경고 또는 오류 메시지로 표시합니다.

// @ts-check
export function init(config) {
  return true;
}

export function exit(code) {
  return code + 1;
}

JSDoc

---

코드에 문서화 주석을 작성하는 방법을 제공하는 도구입니다.

/** ... */와 같은 형식으로 작성되며, 코드의 설명, 함수 및 메서드의 파라미터 및 반환 타입, 클래스 및 모듈의 구조, 코드 예제 등을 기록하는 데 사용됩니다.

자바스크립트 파일 예시

JSDoc은 타입스크립트에게 타입 정보 제공을 할 수 있습니다.

// @ts-check

/**
 * Initializes the projext
 * @param {object} config
 * @param {boolean} config.debug
 * @param {string} config.url
 * @returns boolean
 */
export function init(config) {
  return true;
}

/**
 * Exits the program
 * @param {number} code
 * @returns number
 */
export function exit(code) {
  return code + 1;
}