如何使用typescript支持同一模块的多个版本



我正在制作一个typescript npm包
它使用discord.js,但discord.jss有两个主要版本:
*discord.js11.5
*discord.jsv12.0.0-dev

我希望我的模块支持这两个版本。我的意思是,用户可以安装他们想要的discord.js版本,并且包将使用好的代码。

对于另一个项目,在javascript(没有typescript(中,我使用以下内容:

const { version } = require("discord.js");
if(version === "12.0.0-dev"){
// code for v12
} else {
// code for v11
}

而且效果非常好。但是,由于打字的原因,打字更为复杂。事实上,在v11和v12中,discord.js的类型不一样,所以我不能用这两个版本编译代码:

const { Guild, version } = require("discord.js");
if(version === "12.0.0-dev"){
Guild.iconURL(); // for v12
} else {
Guild.iconURL; // for v11
}

如果安装了v12,它将抛出iconURL() doesn't exist on Guild,如果是v11,则抛出iconURL doesn't exist on Guild
是否有任何方法可以在同一个包中支持两个版本,而不为每个版本创建分支?

虽然不理想,但您可以手动下载v11和v12的键入,并将模块名称更改为以下内容:

// discord.js@11.d.ts
declare module 'discord.js@11' {
...
}
// discord.js@12.d.ts
declare module 'discord.js@12' {
...
}

然后你可以导入这样的类型:

import { Guild as Guild12, version } from "discord.js";
import { Guild as Guild11 } from "discord.js@11";
declare const guild: Guild11 | Guild12 // obviously wouldn't be declared like this in your actual code
// At the time of writing v12.0.2 has been released
if (version === "12.0.2") {
(guild as Guild12).iconURL(); // for v12
} else {
(guild as Guild11).iconURL; // for v11
}

您还可以定义类型保护:

function isV12(guild: Guild11 | Guild12): guild is Guild12 {
return version === "12.0.2";
}
if (isV12(guild)) {
guild.iconURL();
} else {
guild.iconURL();
}

我尝试过混叠discord@11和discord@12类似于package.json:

"devDependencies": {
"discord.js11": "npm:discord.js@11.6.2",
"discord.js12": "npm:discord.js@12.0.2"
}

但我得到了这个错误:

import { Guild as Guild12, version } from "discord.js12";
//                                        ~~~~~~~~~~~~~~
// with pnpm:
// File '/path/to/project/node_modules/.pnpm/registry.npmjs.org/discord.js/12.0.2/node_modules/discord.js/typings/index.d.ts' is not a module. (ts2306)
// with npm:
// File '/path/to/project/node_modules/discord.js12/typings/index.d.ts' is not a module. (ts2306)

npm i formik-v2@npm:formik@2.0.0

yarn add formik-v2@npm:formik@2.0.0

然后你可以

import * from 'formik-v2'

https://medium.com/weekly-webtips/how-to-install-multiple-versions-of-the-same-package-in-npm-71c29b12e253

最新更新