Was this page helpful?

Do's and Don'ts

일반 타입 (General Types)

Number, String, Boolean, Symbol and Object

Number, String, Boolean, Symbol, Object 타입을 사용하지 마세요. 이 타입들은 JavaScript 코드에서 거의 사용되지 않는 비-원시형 박싱된 객체를 가르킵니다.

ts
/* 잘못됨 */
function reverse(s: String): String;

number, string, boolean, symbol 타입을 사용 하세요.

ts
/* 좋음 */
function reverse(s: string): string;

Object 대신에, TypeScript 2.2 에 추가된 비-원시형 object타입을 사용하세요.

제네릭 (Generics)

타입 매개변수를 사용하지 않는 제네릭 타입을 사용하지 마세요. 더 자세한 내용은 TypeScript FAQ 페이지에서 확인하세요.

콜백 타입 (Callback Types)

콜백의 반환 타입 (Return Types of Callbacks)

사용하지 않는 콜백의 반환 값 타입에 any를 사용하지 마세요:

ts
/* 잘못됨 */
function fn(x: () => any) {
x();
}

사용하지 않는 콜백의 반환 값 타입은 void를 사용하세요:

ts
/* 좋음 */
function fn(x: () => void) {
x();
}

이유: void를 사용하면 실수로 x의 반환 값을 사용하는 것을 방지 할 수 있기 때문에 더 안전합니다.:

ts
function fn(x: () => void) {
var k = x(); // oops! meant to do something else
k.doSomething(); // error, but would be OK if the return type had been 'any'
}

콜백에서 선택적 매개변수 (Optional Parameters in Callbacks)

정말 의도한 것이 아니라면 콜백에 선택적 매개변수를 사용하지 마세요:

ts
/* 잘못됨 */
interface Fetcher {
getObject(done: (data: any, elapsedTime?: number) => void): void;
}

이는 아주 구체적인 의미를 가지고 있습니다: done 콜백은 1개 혹은 2개의 인자로 호출될 수 있습니다. 작성자는 아마 elapsedTime 매개변수가 콜백에 상관없다는 것을 말하려는 의도였을 것입니다, 하지만 이를 위해 매개변수를 선택적으로 만들 필요는 없습니다 — 콜백에 더 적은 인수를 제공하는 것은 항상 허용됩니다.

콜백 매개변수를 비-선택적으로 작성하세요:

ts
/* 좋음 */
interface Fetcher {
getObject(done: (data: any, elapsedTime: number) => void): void;
}

오버로드와 콜백 (Overloads and Callbacks)

콜백의 인수만 다른 오버로드를 분리해서 작성 하지 마세요:

ts
/* 잘못됨 */
declare function beforeAll(action: () => void, timeout?: number): void;
declare function beforeAll(action: (done: DoneFn) => void, timeout?: number): void;

최대 인수를 사용해 하나의 오버로드를 작성 하세요:

ts
/* 좋음 */
declare function beforeAll(action: (done: DoneFn) => void, timeout?: number): void;

이유: 콜백이 매개변수를 무시하는 것은 항상 허용되므로, 짧은 오버로드는 필요하지 않습니다. 더 짧은 콜백을 먼저 작성하면 넘어오는 함수가 첫 번째 오버로드와 일치하기 때문에 잘못된-타입의 함수를 허용합니다.

함수 오버로드 (Function Overloads)

순서 (Ordering)

더 일반적인 오버로드를 더 구체적인 오버로드 이전에 두지 마세요:

ts
/* 잘못됨 */
declare function fn(x: any): any;
declare function fn(x: HTMLElement): number;
declare function fn(x: HTMLDivElement): string;
var myElem: HTMLDivElement;
var x = fn(myElem); // x: any, wat?

구체적인 오버로드 뒤에 일반적인 오버로드가 위치하게 정렬 하세요:

ts
/* 좋음 */
declare function fn(x: HTMLDivElement): string;
declare function fn(x: HTMLElement): number;
declare function fn(x: any): any;
var myElem: HTMLDivElement;
var x = fn(myElem); // x: string, :)

이유: TypeScript는 함수 호출을 처리할 때 첫 번째로 일치하는 오버로드를 선택합니다. 이전의 오버로드가 뒤에 것보다 “더 구체적”이면, 뒤에 것은 사실상 가려져 호출되지 않습니다.

선택적 매개변수 사용 (Use Optional Parameters)

뒤따라오는 매개변수만 다른 오버로드를 작성하지 마세요:

ts
/* 잘못됨 */
interface Example {
diff(one: string): number;
diff(one: string, two: string): number;
diff(one: string, two: string, three: boolean): number;
}

가능한 선택적 매개변수를 사용 하세요:

ts
/* 좋음 */
interface Example {
diff(one: string, two?: string, three?: boolean): number;
}

이 문제는 모든 오버로드가 같은 반환 타입을 가질 때만 발생한다는 점에 유의하세요.

이유: 두 가지 중요한 이유가 있습니다.

TypeScript는 소스의 인수로 대상의 시그니처를 호출할 수 있는지 확인하여 시그니처 호환성을 결정합니다. 그리고 관계없는 인수가 허용됩니다 예를 들어, 이 코드는 선택적 매개변수를 사용하여 올바르게 작성된 경우에만 버그를 노출합니다:

ts
function fn(x: (a: string, b: number, c: number) => void) { }
var x: Example;
// 오버로드로 작성한 경우, OK -- 첫번째 오버로드가 사용됨
// 선택적으로 작성한 경우, 올바르게 오류.
fn(x.diff);

두 번째 이유는 사용자가 TypeScript의 “strict null checking” 기능을 사용할 때입니다. JavaScript에서 지정되지 않은 매개변수는 undefined로 나타나기 때문에, 일반적으로 선택적 매개변수가 있는 함수에 명시적으로 undefined를 전달하는 것이 좋습니다. 예를 들어, 이 코드는, strict null에서 문제없습니다.

ts
var x: Example;
// 오버로드로 작성한 경우, `undefined`를 `string` 에 전달했기 때문에 잘못된 에러
// 선택적으로 작성한 경우, 올바름
x.diff("something", true ? undefined : "hour");

유니언 타입 사용 (Use Union Types)

한 인수 위치에서 타입만 다른 오버로드를 사용하지 마세요:

ts
/* 잘못됨 */
interface Moment {
utcOffset(): number;
utcOffset(b: number): Moment;
utcOffset(b: string): Moment;
}

가능한 유니언 타입을 사용 하세요:

ts
/* 좋음 */
interface Moment {
utcOffset(): number;
utcOffset(b: number|string): Moment;
}

시그니처의 반환 타입이 다르기 때문에 b를 선택적으로 만들지 않은 점에 유의하세요.

이유: 이는 함수에 값을 “전달하는” 사람들에게 중요합니다.:

ts
function fn(x: string): void;
function fn(x: number): void;
function fn(x: number|string) {
// 분리된 오버로드로 작성된 경우, 잘못된 에러
// 유니언 타입으로 작성된 경우, 올바름
return moment().utcOffset(x);
}

The TypeScript docs are an open source project. Help us improve these pages by sending a Pull Request

Contributors to this page:
MHMohamed Hegazy  (55)
  (6)
OTOrta Therox  (1)
VKVeniamin Krol  (1)
SSean  (1)
10+

Last updated: 2021년 9월 20일