typescript - 如果创建库，我应该手动验证 TypeScript 中的参数吗？

Question

至少粗略地了解 TypeScript 的工作原理，每个人都可以回答:“是的。TypeScript 只是将代码转换为 JavaScript，但不会添加任何额外的行为，包括执行期间的类型检查。”例如，

function example(parameter: string): void {
  console.log(parameter.charAt(1));
}

将被转译为:

"use strict";
function example(parameter) {
  console.log(parameter.charAt(1));
}

如果 JavaScript 用户将调用 example(3)，将抛出错误 Uncaught TypeError: parameter.charAt is not a function。

好吧，如果我理解这一点，为什么我会问这个问题？因为我要花几十个小时来改进我的图书馆(@yamato-daiwa/es-extensions )，但更重要的是，将库大小增加数倍。一点也不夸张。例如，对于版本 1.6.x，addElementsToArray函数非常简单并且没有依赖关系:

export default function addElementsToArray<ArrayElement>(
  namedParameters:
    {
      targetArray: Array<ArrayElement>;
      newElements: Array<ArrayElement>;
      mutably: boolean;
    } &
    (
      { toStart: true; } |
      { toEnd: true; } |
      { toPosition__numerationFrom0: number; } |
      { toPosition__numerationFrom1: number; }
    )
): Array<ArrayElement> {

  const workpiece: Array<ArrayElement> = namedParameters.mutably ?
      namedParameters.targetArray : [ ...namedParameters.targetArray ];

  if ("toStart" in namedParameters) {
    workpiece.unshift(...namedParameters.newElements);
    return workpiece;
  }


  if ("toEnd" in namedParameters) {
    workpiece.push(...namedParameters.newElements);
    return workpiece;
  }


  const positionOfFirstNewElement__numerationFrom0: number = "toPosition__numerationFrom0" in namedParameters ?
      namedParameters.toPosition__numerationFrom0 : namedParameters.toPosition__numerationFrom1 - 1;

  workpiece.splice(positionOfFirstNewElement__numerationFrom0, 0, ...namedParameters.newElements);

  return workpiece;
}

一旦我通过类型检查对其进行了改进，它就变成了:

import Logger from "../Logging/Logger";
import InvalidParameterValueError from "../Errors/InvalidParameterValue/InvalidParameterValueError";
import IncompatiblePropertiesInObjectTypeParameterError from
    "../Errors/IncompatiblePropertiesInObjectTypeParameter/IncompatiblePropertiesInObjectTypeParameterError";
import stringifyAndFormatArbitraryValue from "../Strings/stringifyAndFormatArbitraryValue";
import isArbitraryObject from "../TypeGuards/Objects/isArbitraryObject";
import isNotUndefined from "../TypeGuards/Nullables/isNotUndefined";
import isNonNegativeInteger from "../TypeGuards/Numbers/isNonNegativeInteger";
import isNaturalNumber from "../TypeGuards/Numbers/isNaturalNumber";


export default function addElementsToArray<ArrayElement>(
  namedParameters:
      Readonly<
        (
          {
            mutably: true;
            targetArray: Array<ArrayElement>;
          } |
          {
            mutably: false;
            targetArray: ReadonlyArray<ArrayElement>;
          }
        ) &
        {
          newElements: ReadonlyArray<ArrayElement>;
          toStart?: true;
          toEnd?: true;
          toPosition__numerationFrom0?: number;
          toPosition__numerationFrom1?: number;
        }
      >
): Array<ArrayElement> {

  if (!isArbitraryObject(namedParameters)) {
    Logger.throwErrorAndLog({
      errorInstance: new InvalidParameterValueError({
        parameterNumber: 1,
        parameterName: "namedParameters",
        messageSpecificPart: "The first and only parameter of 'addElementsToArray' must be of the object type."
      }),
      title: InvalidParameterValueError.localization.defaultTitle,
      occurrenceLocation: "addElementsToArray(namedParameters)"
    });
  }


  if (!Array.isArray(namedParameters.targetArray)) {
    Logger.throwErrorAndLog({
      errorInstance: new InvalidParameterValueError({
        parameterName: "namedParameters",
        parameterNumber: 1,
        messageSpecificPart: "The 'targetArray' is not the valid array and has value:\n" +
            `${ stringifyAndFormatArbitraryValue(namedParameters.targetArray) }`
      }),
      title: InvalidParameterValueError.localization.defaultTitle,
      occurrenceLocation: "addElementsToArray(namedParameters)"
    });
  }


  const alternativelyRequestOptions: Array<true | number> = [
    namedParameters.toStart,
    namedParameters.toEnd,
    namedParameters.toPosition__numerationFrom0,
    namedParameters.toPosition__numerationFrom1
  ].filter(isNotUndefined);

  if (alternativelyRequestOptions.length > 1) {

    Logger.logError({
      errorType: IncompatiblePropertiesInObjectTypeParameterError.NAME,
      title: IncompatiblePropertiesInObjectTypeParameterError.localization.defaultTitle,
      description: "Exactly one of 'toStart', 'toEnd', 'toPosition__numerationFrom0', 'toPosition__numerationFrom1' " +
          "must be specified while actually multiple of them has been. No elements will be added to target array.",
      occurrenceLocation: "addElementsToArray(namedParameters)"
    });

    return namedParameters.targetArray;

  }


  const workpiece: Array<ArrayElement> = namedParameters.mutably ?
      namedParameters.targetArray : [ ...namedParameters.targetArray ];

  if (namedParameters.toStart === true) {
    workpiece.unshift(...namedParameters.newElements);
    return workpiece;
  }


  if (namedParameters.toEnd === true) {
    workpiece.push(...namedParameters.newElements);
    return workpiece;
  }


  let positionOfFirstNewElement__numerationFrom0: number;

  if (isNonNegativeInteger(namedParameters.toPosition__numerationFrom0)) {
    positionOfFirstNewElement__numerationFrom0 = namedParameters.toPosition__numerationFrom0;
  } else if (isNaturalNumber(namedParameters.toPosition__numerationFrom1)) {
    positionOfFirstNewElement__numerationFrom0 = namedParameters.toPosition__numerationFrom1 - 1;
  } else {

    Logger.logError({
      errorType: InvalidParameterValueError.NAME,
      title: InvalidParameterValueError.localization.defaultTitle,
      description: alternativelyRequestOptions.length === 0 ?
          "None one of 'toStart', 'toEnd', 'toPosition__numerationFrom0', 'toPosition__numerationFrom1' has been specified." :
          (
            "The specified value of 'toStart', 'toEnd', 'toPosition__numerationFrom0' or 'toPosition__numerationFrom1' has " +
            "invalid type, value or numbers set."
          ) +
          "No elements will be added to target array.",
      occurrenceLocation: "addElementsToArray(namedParameters)"
    });

    return namedParameters.targetArray;

  }


  workpiece.splice(positionOfFirstNewElement__numerationFrom0, 0, ...namedParameters.newElements);

  return workpiece;

}

在这种情况下，验证占用了大约一半的行，并且还出现了很多依赖项。有时，验证可以超过 90% 的功能行。库可分发文件将因多种类型而变得更重，这对于每一千字节都非常重要的前端应用程序至关重要。

以上检查还不够细致!此外，我们可以:

• 当可选的命名参数(toStart、toEnd、toPosition__numerationFrom0、toPosition__numerationFrom1)大于 1 时, 检查他们中的哪一个已经通过并记录他们的名字。
• 拆分检查这些参数的类型，检查是否这些参数都没有通过(目前这两个检查正在同时进行)
• 如果上述参数的子类型不正确(例如，如果 toStart 或 toEnd 的值为 false 或 toPosition__numerationFrom0或 toPosition__numerationFrom1 是负数或小数)，单独记录。

潜在的虚假问题

简而言之，非 TypeScript 用户可能会报告由无效参数类型引起的错误，但是如果 TypeScript 编写了相同的代码，TypeScript 就会发出错误。最终很明显，问题是由于结合使用 JavaScript 而不是 TypeScript 的无效参数类型，时间将被调查、对话等浪费。也可能是大量此类问题实际上只是无效的 TypeScript。

赏金事件更新

这个问题已经得到解答，但由于参数验证， future 我的库大小可能会增加数倍，这让我很烦恼。要穷尽这个问题，我需要被告知“你做的是正确的，继续做下去!如果因为参数验证，将分配的大小增加多次对于前端应用程序来说并不重要。”或“由于参数的验证，帮助程序库的大小永远都不好。您应该跳过参数验证以保持库的 slim 。”由高级/主 Web 开发人员编写。

Answer 1

在系统面向客户的边缘进行验证是一种很好且常见的做法。

一开始所有那些清嗓子的代码都可以看作是一件好事，使这些函数的主体更加简单和自信地编写。

您当然也可以通过查找或构建断言库来缩减代码。