Class: UserPermissionsPrecondition

Constructs a contextful permissions precondition requirement.

since 1.0.0

example

export class CoreCommand extends Command {
  public constructor(context: PieceContext) {
    super(context, {
      preconditions: [
        'GuildOnly',
        new UserPermissionsPrecondition('ADD_REACTIONS')
      ]
    });
  }

  public messageRun(message: Message, args: Args) {
    // ...
  }
}

Implements

• PreconditionSingleResolvableDetails<"UserPermissions">

Constructors

constructor

• new UserPermissionsPrecondition(permissions)

Constructs a precondition container entry.

Parameters

Name	Type	Description
permissions	PermissionResolvable	The permissions that will be required by this command.

Defined in

projects/framework/src/lib/utils/preconditions/containers/UserPermissionsPrecondition.ts:33

Properties

context

• context: Object

The context to be set at PreconditionContainerSingle.context.

Type declaration

Name	Type
permissions	Permissions

Implementation of

PreconditionSingleResolvableDetails.context

Defined in

projects/framework/src/lib/utils/preconditions/containers/UserPermissionsPrecondition.ts:27

---

name

• name: "UserPermissions"

The name of the precondition to retrieve from {@link SapphireClient.preconditions}.

Implementation of

PreconditionSingleResolvableDetails.name

Defined in

projects/framework/src/lib/utils/preconditions/containers/UserPermissionsPrecondition.ts:26