使用适用于.NET的NPM API包装器

目录

介绍

使用代码

使用注册表API

Registry.SearchPackages

Registry.GetPackageVersion

命令

Command.RunBaseInstall

Command.RunInstall

Commands.RunUninstal

---

• 从Github下载源代码

介绍

这可以帮助想要使用NPM注册表API/CLI执行操作的项目，提供一组易于使用和设置的工具。

使用代码

使用NPMWrap的第一步是实际安装它，可以使用CLI或（如果使用的是Visual Studio）管理NuGet包并从那里安装它。可以在此处查看NuGet包（以及用于安装它的可用命令）。

根据你想如何使用它，你可以在NPM注册表API中搜索包，它会自动获取API并对数据执行操作以使其更易于处理。

使用注册表API

如果要搜索可用的软件包，请使用NPMWrap.Registry.SearchPackages，要获取软件包版本，请使用NPMWrap.Registry.GetPackageVersion。

Registry.SearchPackages

这将返回一个SearchResult对象，其用法示例如下：

NPMWrap.Registry.Config Configuration = new NPMWrap.Registry.Config()
{
   UserAgent = "Your user agent" // Example: NPMWrap
};

SearchResult Result = await NPMWrap.Registry.SearchPackages("Express", Configuration);

Registry.GetPackageVersion

这将返回一个RegistryPackageVersion对象，其用法示例（类似于Registry.SearchPackages）为：

NPMWrap.Registry.Config Configuration = new NPMWrap.Registry.Config()
{
   UserAgent = "Your user agent" // Example: NPMWrap
}

RegistryPackageVersion PackageVersion = 
    await NPMWrap.Registry.GetPackageVersion("Express", Configuration);

而且，如果您想获取特定版本而不仅仅是最新版本，请在第一个字符串和配置之间放置一个小版本代码。

这基本上是注册表部分。

命令

在对命令执行任何操作之前，需要设置一些配置，例如：

NPMWrap.Commands.Config Configuration = new NPMWrap.Commands.Config()
{
   UseYarn = false, // Depending on if you want to use Yarn or not.
   Directory = "C:/Path/To/Working/Directory", // If you leave this blank,
                                               // it will throw an exception.
   IsDebug = false, // If set to true and a command is run the CMD window will be visible.
   WaitForExit = true // If you wait for it to exit, 
                      // it may clog up the thread until NPM or Yarn has finished.
};

Command.RunBaseInstall

这基本上只是执行npm install或基于给定的配置的yarn，例如：

await RunBaseInstall(Configuration);

Command.RunInstall

用于添加软件包的安装命令，例如：

await RunBaseInstall("Express", Configuration);

这也可用于安装特定版本的包，只需在第一个字符串之后插入版本代码作为字符串即可。

Commands.RunUninstal

uninstallation命令将删除软件包，例如：

await RunBaseUninstall("React", Configuration);

https://www.codeproject.com/Articles/5372265/Using-the-NPM-API-Wrapper-for-NET