discord.js | setPosition

Search...

setPosition

export function setPosition<T extends Channel | Role>(
  item: T,
  position: number,
  relative: boolean,
  sorted: Collection<Snowflake, T>,
  client: Client<true>,
  route: string,
  reason?: string,
): Promise<{ id: Snowflake; position: number }[]>;

export function setPosition<T extends Channel | Role>(
  item: T,
  position: number,
  relative: boolean,
  sorted: Collection<Snowflake, T>,
  client: Client<true>,
  route: string,
  reason?: string,
): Promise<{ id: Snowflake; position: number }[]>;

Sets the position of a Channel or Role.

Returns

Updated item list, with id and position properties

Name	Constraints	Optional	Default	Description
T	Channel \| Role	No		None

Name	Type	Optional	Description
item	T	No	Object to set the position of
position	number	No	New position for the object
relative	boolean	No	Whether `position` is relative to its current position
sorted	Collection<Snowflake, T>	No	A collection of the objects sorted properly
client	Client<true>	No	The client to use to patch the data
route	string	No	Route to call PATCH on
reason	string	Yes	Reason for the change