如何将我的代码从 v11 迁移到 Discord.js v12？

Question

我升级到 Discord.js v12，但它破坏了我现有的 v11 代码。以下是一些导致错误的示例：

// TypeError: client.users.get is not a function
const user = client.users.get('123456789012345678')

// TypeError: message.guild.roles.find is not a function
const role = message.guild.roles.find(r => r.name === 'Admin')

// TypeError: message.member.addRole is not a function
await message.member.addRole(role)

// TypeError: message.guild.createChannel is not a function
await message.guild.createChannel('welcome')

// TypeError: message.channel.fetchMessages is not a function
const messages = await message.channel.fetchMessages()

const {RichEmbed} = require('discord.js')
// TypeError: RichEmbed is not a constructor
const embed = new RichEmbed()

const connection = await message.channel.join()
// TypeError: connection.playFile is not a function
const dispatcher = connection.playFile('./music.mp3')

如何将我的代码迁移到 Discord.js v12 并修复这些错误？我在哪里可以看到引入的重大更改 v12？

Answer 1

以下是人们遇到的 Discord.js v12 中引入的一些最常见的重大更改。

经理

Client#users 和Guild#roles 等属性现在是ma​​nagers，而不是缓存的Collection 项。要访问此集合，请使用 cache 属性：

const user = client.users.cache.get('123456789012345678')
const role = message.guild.roles.cache.find(r => r.name === 'Admin')

此外，GuildMember#addRole、Guild#createChannel、TextBasedChannel#fetchMessages 等方法已移至各自的管理器：

await message.member.roles.add(role)
await message.guild.channels.create('welcome')
const messages = await message.channel.messages.fetch()

Collection

Collection 类（例如 client.users.cache、guild.roles.cache、guild.channels.cache）现在只接受 函数，而不接受 .find 和 .findKey 的属性键和值：

// v11: collection.find('property', 'value')
collection.find(item => item.property === 'value')

.exists、.deleteAll、.filterArray、.findAll 也已被删除：

// v11: collection.exists('property', 'value')
collection.some(item => item.property === 'value')

// v11: collection.deleteAll()
Promise.all(collection.map(item => item.delete()))

// v11: collection.filterArray(fn)
collection.filter(fn).array()

// v11: collection.findAll('property', value')
collection.filter(item => item.property === 'value').array()

.tap 现在对集合而不是集合中的每个项目运行一个函数：

// v11: collection.tap(item => console.log(item))
collection.each(item => console.log(item))

// New .tap behaviour:
collection.tap(coll => console.log(`${coll.size} items`))

RichEmbed/MessageEmbed

RichEmbed 类已被移除；改用 MessageEmbed 类，该类现在用于所有嵌入（而不是仅接收到的嵌入）。

const {MessageEmbed} = require('discord.js')
const embed = new MessageEmbed()

addBlankField 方法也已被删除。该方法只是简单地添加了一个带有零宽度空格 (\u200B) 的字段作为名称和值，因此要添加一个空白字段，请执行以下操作：

embed.addField('\u200B', '\u200B')

语音

所有VoiceConnection/VoiceBroadcast#play***方法都统一在一个play方法下：

const dispatcher = connection.play('./music.mp3')

Client#createVoiceBroadcast 已移至ClientVoiceManager：

const broadcast = client.voice.createVoiceBroadcast()

此外，StreamDispatcher 扩展了 Node.js 的 stream.Writable，因此请使用 dispatcher.destroy() 而不是 dispatcher.end()。 end 事件已被移除，取而代之的是原生 finish 事件。

图片网址

User#displayAvatarURL 和 Guild#iconURL 等属性现在是方法：

const avatar = user.displayAvatarURL()
const icon = mesage.guild.iconURL()

您还可以传递ImageURLOptions 来自定义格式和大小等内容。

更多信息

要了解有关 v12 重大更改的更多信息，请查看 the updating guide 和 changelog。 documentation 也是查找特定方法/属性的好资源。