在 Typescript 中注释函数

深入探索TypeScript函数类型注解：从基础到高级泛型

本文将深入探讨TypeScript中函数类型注解的各种技巧，从基础的函数注解到处理回调函数、泛型函数以及函数接口，并辅以示例代码，帮助您构建更健壮、更易维护的TypeScript代码。

基础函数注解

在TypeScript中，注释函数最基本的方法如下所示：

function add(a: number, b: number): number {
  // 函数逻辑
}

// 或者使用箭头函数
const add = (a: number, b: number): number => {
  // 函数逻辑
};

可选参数

可选参数使用问号?进行注解：

function optional(a: number, b?: number) {
  console.log(a);
}

回调函数与函数类型

对于回调函数或参数类型和返回值类型相关的函数（特别是泛型函数），我们需要使用函数类型注解：

// 函数类型注解  (param1: type1, param2: type2) => returnType
const add: (a: number, b: number) => number = function(a, b) {
  return a + b;
};

// 注释 `multiplier` 函数
function multiplier(factor: number): (value: number) => number {
  return value => factor * value;
}

泛型函数

泛型函数使用<T>语法来定义类型参数：

// 正确的泛型函数注解
function pickFirst<T>(array: Array<T>): T {
  return array[0];
}

错误的泛型函数注解示例：

// 错误的注解，无法识别类型 'T'
function pickFirst(array: Array<T>): T { // 错误：T 未定义
  return array[0];
}

具有函数参数的泛型函数

当泛型函数的参数也是函数时，需要嵌套使用函数类型注解：

// 注释 `myMap` 函数
function myMap<Input, Output>(
  arr: Input[],
  fn: (item: Input, index?: number) => Output
): Output[] {
  return arr.map(fn);
}

// 注释 `myFilter` 函数
function myFilter<Input>(arr: Input[], fn: (item: Input) => boolean): Input[] {
  return arr.filter(fn);
}

// 注释 `myFrom` 函数
function myFrom<Type>(iterable: Iterable<Type>): Array<Type> {
  // 函数逻辑
}

泛型约束

可以使用extends关键字对泛型参数进行约束，例如：

// 泛型约束，确保 T 必须是数字数组
function pickInnerFirst<T extends number[][]>(array: Array<T>): T[0][0] {
  return array[0][0];
}

// 使用接口进行泛型约束
interface Lengthly {
  length: number;
}

function pickInnerFirst<T extends Lengthly[]>(array: Array<T>): T[0][0] {
  return array[0][0];
}

函数接口

函数也是对象，可以使用接口来描述函数的类型和属性：

interface DescribableFunction {
  (value: string): void;
  description: string;
}

function shout(fn: DescribableFunction, value: string) {
  fn(value);
  console.log(fn.description);
}

function hey(value: string) {
  console.log(value);
}

hey.description = `A function called ${hey.name}`;
shout(hey, "Hola!!!");

总结

熟练掌握TypeScript的函数类型注解，特别是泛型函数和函数接口的用法，对于构建高质量、可维护的TypeScript代码至关重要。 这有助于提高代码的可读性，并能帮助TypeScript编译器进行更有效的类型检查，减少运行时错误。 希望本文能够帮助您更好地理解和应用这些概念。