cmd.user.edit.nick

Sets or resets the server nickname of a guild member.

JavaScript

const { cmd } = require("syntx.js");

await cmd.user.edit.nick({ user, nick }, message);

Parameters

Parameter	Type	Required	Description
`user`	`string \| discord.js User`	Yes	The user ID or user object whose nickname to change.
`nick`	`string \| null`	Yes	The new nickname to set. Pass `null` to reset it to the user's username.
`message`	discord.js `Message`	Yes	A guild message or interaction, used to access the guild.

Returns

This function does not return a value.

Examples

Set a nickname

JavaScript

client.command({
  name: "nick",
  content: async (message) => {
    const id = cmd.message.mentioned(message, 1);
    if (!id) return message.reply("Please mention a user.");

    await cmd.user.edit.nick({ user: id, nick: "Cool Guy" }, message);
    message.reply("Nickname updated.");
  },
});

Reset a nickname

JavaScript

client.command({
  name: "resetnick",
  content: async (message) => {
    const id = cmd.message.mentioned(message, 1);
    if (!id) return message.reply("Please mention a user.");

    await cmd.user.edit.nick({ user: id, nick: null }, message);
    message.reply("Nickname reset.");
  },
});

Warning

The bot must have the Manage Nicknames permission and a higher role than the target member. If either condition is not met, a SyntxError is thrown.