Skip to content

Function: removeGroup() ​

ts
function removeGroup(
   client, 
   parameters, 
   options?
): Promise<void>;

Defined in: src/server/api/groups.ts:28

Deletes a group by given group parameter

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ groupname: string; swapGroup?: string; }-
parameters.groupnamestringThe name of the group to delete.
parameters.swapGroup?stringA different group to transfer the restrictions to.
options?RequestOptions-

Returns ​

Promise<void>