jjzjj

javascript - 是否可以在 ES6 项目中使用自定义类型定义?

coder 2023-05-30 原文

我的团队从事一个相对较大的 NodeJS 项目,用 ES6 编写,通过 babel 进行转译,然后使用无服务器部署为 AWS lambdas。这个项目的重点是消费、映射/转换和输出我们定义的一种特定对象类型。

我们的问题是,ECMA/JavaScript 不是强类型的,所以如果我们犯了一个错误,比如在某处将字段视为数组,而在其他地方将字符串视为字符串,除了运行时错误外,没有什么可以捕捉到的。我们也没有很好地记录这个对象的结构,所以有时消费者会向我们发送对象的实例,其中包含我们说我们处理但实际上并没有使用的稍微命名错误的字段中的数据。

我正在寻找一种方法来为我们项目中的这个特定对象创建某种模式或类型定义,以便我们可以使用它来更正我们的代码,使我们的处理更加健壮,并为它创建更好的文档。现在,我知道 VSCode 提供了一些 basic type checking在 JavaScript 中,但我认为尝试 JSDoc 一个非常大的对象然后将该文档放入使用该对象的每个文件中是不可行的。我发现 VSCode 也可以以某种方式驱动检查 with .d.ts files但我不明白是否或如何将其用于我们设计的特定自定义对象。我发现的大部分内容似乎都与为外部库拉取 .d.ts 文件特别相关。

那么,TL:DR,在 NodeJS/ES6 项目中,是否有可能使一个在整个项目中广泛使用的对象成为强类型的? VSCode 中的错误检查是可以接受的,但是我们可以在转译之前触发的某种命令行 linting 也很棒。

最佳答案

好吧,想通了。在我发布这个问题后,我一直在谷歌上搜索,大约一个小时后,点击了 Sequoia McDowell 在 StrongLoop 上的这篇文章:https://strongloop.com/strongblog/type-hinting-in-javascript/

我非常密切地关注它,并且使用“typings”包,我能够在我的项目的根目录中初始化一个“typings”文件夹。该文件夹的内容现在如下所示:

typings/
├── models/
│   └── myObject.d.ts
└── index.d.ts

该 index.d.ts 文件的内容如下所示:

/// <reference path="models/myObject.d.ts" />

myObject.d.ts 文件的内容看起来有点像这样:

declare namespace MyProject {
  export interface MyObject {
    aString?: string;
    anotherString?: string;
    aComplexType?: ComplexType;
  }

  interface ComplexType {
    aString?: string;
    anotherComplexType: SecondComplexType;
  }

  interface SecondComplexType {
    aString?: string;
  }
}

完成后,我必须开始使用 JSDoc 标记该对象的实例。该文档主要有两种形式:

/**
 * Creates an instance of UtilityThing.
 * @param {MyProject.MyObject} myObject
 *
 * @memberof UtilityThing
 */
constructor(myObject) {
  this.myObject = myObject;
}

/**
 * @param {MyProject.MyObject} myObject
 * @returns {MyProject.MyObject}
 */
function noOp(myObject) {
  return myObject;
}

/** @type {MyProject.MyObject} */
const myObject = containerObject.myObject;

通过这个设置,以及最新的 VSCode 公开版本,我能够在我当前正在编辑的 ES6 *.js 文件中看到错误,告诉我哪些属性不存在,哪些属性被分配了错误的值类型,被认为是错误的类型,等等。

到了一半。

经过更多研究,我发现这并不是一个独特的 VSCode 功能。似乎他们正在使用“tslint”或它的一些定制版本。利用这些知识,我在项目中添加了“tslint”并制定了这个 npm 脚本:

"tslint": "tslint --type-check --project tsconfig.json"

这是我登陆的 tsconfig.json 的内容,尽管我不完全确定是否需要所有这些选项。

{
  "compilerOptions": {
    "target": "es6",
    "allowJs": true,
    "noResolve": true,
    "checkJs": true,
    "moduleResolution": "node",
    "types": [
      "node"
    ]
  },
  "exclude": [
    "node_modules",
    "coverage",
    "lib",
    "spec"
  ]
}

使用 tsconfig.json 和“typings”文件夹中的类型定义文件运行这个“tslint”脚本允许我使用正确的 JSDoc 对项目中所有文件中的一种特定对象类型进行类型检查。我确实遇到了 small issue但巧合的是,这似乎在一小时前已修复并合并。除了类型检查对象的字段之外,这还揭示了几个地方,其中一个属性被过早地从其后代实际上具有该属性的对象中提取出来。很酷。

TL;DR:可以做到,非常感谢 Sequoia McDowell 的那篇文章,它最终让我走上了正轨。

关于javascript - 是否可以在 ES6 项目中使用自定义类型定义?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/44286781/

有关javascript - 是否可以在 ES6 项目中使用自定义类型定义?的更多相关文章

  1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

    我正在学习如何使用Nokogiri,根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

  2. ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2

    我有一个Ruby程序,它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重,我想提高压缩级别,因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗?是否有另一个允许指定压缩级别的Ruby库? 最佳答案 这是我通过查看ruby​​zip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d

  3. ruby - 为什么我可以在 Ruby 中使用 Object#send 访问私有(private)/ protected 方法? - 2

    类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc

  4. ruby-on-rails - 使用 Ruby on Rails 进行自动化测试 - 最佳实践 - 2

    很好奇,就使用ruby​​onrails自动化单元测试而言,你们正在做什么?您是否创建了一个脚本来在cron中运行rake作业并将结果邮寄给您?git中的预提交Hook?只是手动调用?我完全理解测试,但想知道在错误发生之前捕获错误的最佳实践是什么。让我们理所当然地认为测试本身是完美无缺的,并且可以正常工作。下一步是什么以确保他们在正确的时间将可能有害的结果传达给您? 最佳答案 不确定您到底想听什么,但是有几个级别的自动代码库控制:在处理某项功能时,您可以使用类似autotest的内容获得关于哪些有效,哪些无效的即时反馈。要确保您的提

  5. ruby - 在 Ruby 中使用匿名模块 - 2

    假设我做了一个模块如下:m=Module.newdoclassCendend三个问题:除了对m的引用之外,还有什么方法可以访问C和m中的其他内容?我可以在创建匿名模块后为其命名吗(就像我输入“module...”一样)?如何在使用完匿名模块后将其删除,使其定义的常量不再存在? 最佳答案 三个答案:是的,使用ObjectSpace.此代码使c引用你的类(class)C不引用m:c=nilObjectSpace.each_object{|obj|c=objif(Class===objandobj.name=~/::C$/)}当然这取决于

  6. ruby - 使用 ruby​​ 和 savon 的 SOAP 服务 - 2

    我正在尝试使用ruby​​和Savon来使用网络服务。测试服务为http://www.webservicex.net/WS/WSDetails.aspx?WSID=9&CATID=2require'rubygems'require'savon'client=Savon::Client.new"http://www.webservicex.net/stockquote.asmx?WSDL"client.get_quotedo|soap|soap.body={:symbol=>"AAPL"}end返回SOAP异常。检查soap信封,在我看来soap请求没有正确的命名空间。任何人都可以建议我

  7. ruby - Facter::Util::Uptime:Module 的未定义方法 get_uptime (NoMethodError) - 2

    我正在尝试设置一个puppet节点,但ruby​​gems似乎不正常。如果我通过它自己的二进制文件(/usr/lib/ruby/gems/1.8/gems/facter-1.5.8/bin/facter)在cli上运行facter,它工作正常,但如果我通过由ruby​​gems(/usr/bin/facter)安装的二进制文件,它抛出:/usr/lib/ruby/1.8/facter/uptime.rb:11:undefinedmethod`get_uptime'forFacter::Util::Uptime:Module(NoMethodError)from/usr/lib/ruby

  8. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声? - 2

    关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点?我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等),但我确实想创建一个输出文件。

  9. ruby-on-rails - 如何验证 update_all 是否实际在 Rails 中更新 - 2

    给定这段代码defcreate@upgrades=User.update_all(["role=?","upgraded"],:id=>params[:upgrade])redirect_toadmin_upgrades_path,:notice=>"Successfullyupgradeduser."end我如何在该操作中实际验证它们是否已保存或未重定向到适当的页面和消息? 最佳答案 在Rails3中,update_all不返回任何有意义的信息,除了已更新的记录数(这可能取决于您的DBMS是否返回该信息)。http://ar.ru

  10. ruby-on-rails - 'compass watch' 是如何工作的/它是如何与 rails 一起使用的 - 2

    我在我的项目目录中完成了compasscreate.和compassinitrails。几个问题:我已将我的.sass文件放在public/stylesheets中。这是放置它们的正确位置吗?当我运行compasswatch时,它不会自动编译这些.sass文件。我必须手动指定文件:compasswatchpublic/stylesheets/myfile.sass等。如何让它自动运行?文件ie.css、print.css和screen.css已放在stylesheets/compiled。如何在编译后不让它们重新出现的情况下删除它们?我自己编译的.sass文件编译成compiled/t

随机推荐