npm 包 typed-option 使用教程

介绍

typed-option 是一个用于 TypeScript 的优雅的命令行参数解析工具。它不仅具有强类型验证功能,还可以解析嵌套的参数,并自动生成帮助文档,是一款非常适合前端开发者使用的工具。

安装

使用 npm 可以安装 typed-option。

--- ------- ------ ------------

使用方法

如下所示,首先需要定义一个 Options 类,然后实例化这个类并调用 parse 方法即可获得命令行参数。

------ - -------------- ------- ------- - ---- ---------------

----- --------- ------- ------- -
  ---------
    ------------ ----- --------
  --
  ----- ------ - ----------

  ----------------
    -------- ----- -----
    ------------ ------ -------------
  --
  ----- ------- - ------
-

----- ------- - --- ------------
---------------------------- -- -------

注意点:

  1. 每个选项都要声明一个默认值。
  2. 如果默认值为 undefined,并且在命令行中没有提供该选项,则会抛出异常。
  3. 支持使用 “=” 和 “空格” 等方式设置选项值,如 --name Bob--name=Bob

示例

下面是一个更完整的示例,展示了如何处理嵌套参数,以及如何生成帮助文档。

------ - -------------- ------------- ------- ------- - ---- ---------------

----- --------- ------- ------- -
  ---------
    ------------ ----- --------
  --
  ----- ------ - ----------

  ----------------
    -------- ----- -----
    ------------ ------ -------------
  --
  ----- ------- - ------

  ---------------
    ------------ ---- ---------
    ------------ -
      -
        ----- ---------
        -------- ------
        ------------ ------- -------------
      --
      -
        ----- --------
        -------- ------
        ------------ ------ -------------
      --
    --
  --
  ----------- ------ - ---
-

----- ------- - --- ------------
----------------------------

-- -------------- -
  --------------------------------
- ---- -
  --------------------- ------------- --------------------
-

运行 node myApp.js --help 可以得到以下帮助文档:

--------
  ------           ---- ------                                -------- --------- ----------
  --- ------- --   ----- -----------                                       ---------
  ------------     --- -------                                             --------

--- ---------
  ------ ---       ------ -----------
  ----- ---        ----- -----------

运行 node myApp.js --subcommand deploy 可以得到以下输出:

-------- ----------- ------

结论

typed-option 是一个值得使用的 TypeScript 命令行参数解析工具,它可以帮助程序员编写出更加优雅和易于维护的程序。在实际项目中,通过 typed-option 可以使前端开发者在处理命令行参数时更加得心应手。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/60056a1c81e8991b448e4fd8


猜你喜欢

  • npm 包 vanilla-js-carousel 使用教程

    前言 Vanilla JS 是一种纯 JavaScript 编写的前端框架,它没有依赖于第三方库或框架,使得项目更加简洁、易于维护、易于扩展,且使体积更小。而 Vanilla JS 轮播图组件 van...

    3 年前
  • npm 包 find-anagrams 使用教程

    在开发前端程序时,我们通常会遇到需要对输入的单词进行排序或者查找相关单词的需求。这时候,一个有用的工具就是 npm 包 find-anagrams,它可以帮助我们找到一组单词中所有的字谜词。

    3 年前
  • npm 包 homebridge-raspi-bft-gate 使用教程

    在智能家居时代,许多家庭将家庭智能化变得更容易和便利。其中,homebridge 是一个非常好的开源平台,它可以将硬件设备接入 Apple HomeKit,使用户能够通过 Siri 语音控制家庭设备。

    3 年前
  • npm 包 fuzzy_time 使用教程

    在前端开发中,时间处理经常是必要的,尤其是在需要展示时间的场景下。而对于时间的展示,我们可对时间字符串进行格式化处理。但对于时间字符串的格式化处理,我们需要考虑到用户对时间的认知和习惯。

    3 年前
  • npm 包 webpack-localcache-plugin 使用教程

    前言:在前端开发中,我们的项目依赖一大堆的 npm 包,这些 npm 包的下载和更新可能需要一定时间,加重了我们的开发负担。而 webpack 是一款比较流行的打包工具,可以把各种静态代码(包括 np...

    3 年前
  • npm 包 @belym.a.2105/testcafe 使用教程

    前言 在前端开发中,测试是非常重要的一环。为了方便进行 Web 自动化测试,我们可以使用 TestCafe 工具。而 @belym.a.2105/testcafe 这个 npm 包可以帮助我们更方便地...

    3 年前
  • npm 包 brn 使用教程

    在前端开发中,我们经常需要使用一些工具来快速构建页面组件,例如弹窗、表单、菜单等常用的 UI 组件。这些组件可以在 npm 上找到相关的包,其中 brn 是一个非常优秀的 UI 组件库。

    3 年前
  • NPM包ngx-str-pipe使用教程

    Ngx-str-pipe是一个基于Angular的字符串管道,可用于进行格式化和操作字符串。它是基于RxJS实现,提供多种字符串操作和格式化方法。本篇文章将介绍ngx-str-pipe的基本使用方法和...

    3 年前
  • npm 包 strudel-mobx 使用教程

    什么是 strudel-mobx strudel-mobx 是一个基于 Strudel 框架和 MobX 库的前端工具,用于简化 Web 应用程序的状态管理。它使用 MobX 的响应式机制来提供一种声...

    3 年前
  • npm 包 oidc-provider-dynamodb-adapter 使用教程

    OpenID Connect(OIDC)是一种用于网络身份验证的协议,在 Web 开发中得到广泛应用。OIDC Provider 是 OIDC 的服务器端实现。oidc-provider-dynamo...

    3 年前
  • npm 包 angled-edges 使用教程

    介绍 在前端开发中,有时我们需要将矩形图形切割成有角度的图形。而用 CSS 实现需要用到复杂的 transform、skew 等属性,操作繁琐。npm 包 angled-edges 则可以非常简单地快...

    3 年前
  • npm 包 ilp-plugin-payment-channel-framework 使用教程

    前言 在实际开发中,我们经常需要对支付进行处理。对于支付流程的设计,虽然支付方式千差万别,但是在实现上都有共性的地方。支付通道(Payment Channel)是一种广泛用于移动支付和区块链支付等场景...

    3 年前
  • npm 包 ngx-resource 使用教程

    前言 对于前端工程师来说,使用一些现有的开源库能够大大提高开发的效率,而在 AngularJS 框架中使用 ngx-resource 就是一种不错的选择。本文将会详细介绍如何使用该 npm 包,并且通...

    3 年前
  • npm 包 simple-morse 使用教程

    简介 Morse 码是一种用电信号(主要是电报)来编码的信息交流方式,它将字母、数字等字符按照一定的规则映射成符号序列。 simple-morse 是一个基于 JavaScript 的 npm 包,它...

    3 年前
  • npm 包 tyutil 使用教程

    如今在前端领域,npm 打包工具是常用的工具之一,配合 Node.js 和 Webpack 使用,可以帮助项目进行依赖管理和管理包的版本等。除了常见的 lodash、moment 等包,我们还可以使用...

    3 年前
  • npm 包 eg-init 使用教程

    前言 在前端项目开发中,我们通常需要用到各种第三方库和工具,这些库和工具需要通过 npm 包来进行安装和管理。其中,npm 包 eg-init 是一款可以快速创建基础开发框架的工具,本文将为大家介绍如...

    3 年前
  • npm 包 helmeta 使用教程

    在前端开发中,网站头部的 meta 标签对 SEO 和网站性能优化非常重要。helmeta 是一个简单易用的 npm 包,可以帮助我们很方便地生成和管理网页的 meta 标签。

    3 年前
  • npm 包 ng-infinitescroll 使用教程

    在前端开发中,无限滚动是一个常见的功能。如果网站有大量数据需要展示,这个功能就显得尤为重要。为了实现无限滚动,开发人员需要写很多繁琐的代码。但是,现在有一个 npm 包能够帮我们轻松实现无限滚动功能,...

    3 年前
  • npm 包 supreme-log 使用教程

    在开发过程中,日志是非常重要的。在前端项目中,我们借助 npm 包来处理日志输出非常方便。在这里,介绍一个使用简单且功能强大的 npm 包——supreme-log。

    3 年前
  • npm 包 aws-athena-client 使用教程

    前言 AWS Athena 是一种交互式查询服务,可以让您使用标准 SQL 对 Amazon S3 中的数据进行查询。AWS Athena 可以与多种编程语言集成,其中包括 JavaScript。

    3 年前

相关推荐

    暂无文章