草庐IT

javascript - 如何编写和使用 @types 或 DefinitelyTyped 上不存在的自定义声明文件？

coder 2024-07-27 原文

我正在使用一个名为 foo 的 npm 包，它在 DefinitelyTyped 上不存在。换句话说，@types/foo 不存在(或者可能已过时!)

我希望仍然能够在更严格的设置下使用它，例如 noImplicitAny，因此我需要自己编写自定义定义文件。最后，我想向 DefinitelyTyped 发送拉取请求，以便该文件对我项目之外的其他人有用。

有一些简单的解决方案，比如创建一个名为 ./src/types.d.ts 的全局文件，我可以在其中编写以下内容

declare module "foo" {
    export function hello(): void;
    export function world(): void;
}

但如果我使用该语法，当我将它提交给 DefinitelyTyped 时，我可能需要重写我的模块。

我如何构建我的项目，以便我可以轻松地创作并将本地 .d.ts 文件发送到 DefinitelyTyped？

最佳答案

我将逐步进行解释，因此这可能看起来很长，但按照给出的说明进行操作只需几分钟。事实上，这是您可以在 bash 或 PowerShell 中运行的简短版本!

mkdir -p ./local-types/foo
cd ./local-types/foo
npm init --scope types --yes
echo "export function hello(): void; export function world(): void" > ./index.d.ts
cd ../..
npm install ./local-types/foo

背景

让我们想象一下下面的项目结构:

proj/
├─ tsconfig.json
└─ src/
   └─ ...

在项目的根目录下创建一个 local-types 文件夹。

不管它叫什么，但我们称它为local-types。一旦您很好地掌握了我们在这里所做的事情，您就可以将其更改为您想要的任何内容。

proj/
├─ tsconfig.json
├─ local-types/
└─ src/
   └─ ...

In most cases outside of this example, I might just name this types.

在本地类型目录中创建一个新包

由于您正在尝试导入一个名为 foo 的模块，我们将创建一个名为 foo 的文件夹，其中包含一个 index.d.ts.

// local-types/foo/index.d.ts

export function hello(): void;

export function world(): void;

我们还想通过创建一个 package.json 将它变成一个 npm 包:

cd local-types/foo
npm init --scope types --yes

此时，您的项目应该如下所示:

proj/
├─ tsconfig.json
├─ local-types/
|  └─ foo/
|     └─ index.d.ts
|     └─ package.json
└─ src/
   └─ ...

您现在应该能够从 src 中的任何文件导入 foo。

import { hello, world } from "foo";

hello();
world();

请记住，您可能没有带有 index.d.ts 的单入口点包。在这种情况下，您需要模仿在 npm 上发布的包结构。

将包添加为依赖项(或潜在的 devDependency)

如果您正在编写一个库，您可能需要在依赖项中使用它，但应用程序可能需要使用 devDependencies。只需添加 file:./local-types/foo 作为 @types/foo 的版本:

"dependencies": {
    "@types/foo": "file:local-types/foo"
}

发布到 DefinitelyTyped

您的 .d.ts 文件是否完整且有用？考虑编写一些测试并向 DefinitelyTyped 发送拉取请求，以便其他人可以从您所做的工作中受益!

如果您能够在运行时毫无问题地导入这些包，那么您就已经拥有了合适的包结构。

注意事项

关于javascript - 如何编写和使用 @types 或 DefinitelyTyped 上不存在的自定义声明文件？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/44796039/

自定DefinitelyTypedcodetypeslocal-typesjavascripttypescriptnpm

有关javascript - 如何编写和使用 @types 或 DefinitelyTyped 上不存在的自定义声明文件？的更多相关文章

  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 - 如何从 ruby​​ 中的字符串运行任意对象方法？ - 2

    总的来说，我对ruby​​还比较陌生，我正在为我正在创建的对象编写一些rspec测试用例。许多测试用例都非常基础，我只是想确保正确填充和返回值。我想知道是否有办法使用循环结构来执行此操作。不必为我要测试的每个方法都设置一个assertEquals。例如:describeitem,"TestingtheItem"doit"willhaveanullvaluetostart"doitem=Item.new#HereIcoulddotheitem.name.shouldbe_nil#thenIcoulddoitem.category.shouldbe_nilendend但我想要一些方法来使用

  3. 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

  4. 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

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

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

  6. 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$/)}当然这取决于

  7. 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请求没有正确的命名空间。任何人都可以建议我

  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

随机推荐