Skip to content

获取包的版本号

本教程是 Iconify Tools包函数文档 的一部分。

函数 getPackageVersion() 是一个简单的函数,用于从目标目录中的 package.json 获取版本号。

它被 downloadNPMPackage() 用于获取已下载并解压的包的版本号。它也可用于获取从 Git 仓库下载的包的版本号(如下例所示)。

用法

该函数具有以下参数:

  • targetstring 类型。目标目录,不包含 "/package.json"。

函数以 string 类型返回版本号。

另请参阅 getNPMVersion()

该函数为异步函数。

示例

example.ts
tsimport { downloadGitHubRepo, getPackageVersion } from '@iconify/tools';

// GITHUB_TOKEN=ghp_12345 node example.js
const token = process.env.GITHUB_TOKEN || '';

(async () => {
   // Download GitHub repository
   const result = await downloadGitHubRepo({
       target: 'downloads/bi',
       user: 'twbs',
       repo: 'icons',
       branch: 'main',
       token,
   });

   // Get version from downloaded package
   const version = await getPackageVersion(result.contentsDir);

   // '1.7.0'
   console.log('Version:', version);
})();