@pumpkin-plugins/docs API / info / CommandInfo

Interface: CommandInfo<Node>

Defined in: tools/docs/src/info.ts:42

A command the plugin lists in its README. Build these with commandInfos rather than writing them.

Type Parameters

Node

Node extends string = string

Properties

defaultPermission?

optional defaultPermission?: CommandPermissionDefault

Defined in: tools/docs/src/info.ts:49

Who may run the command by default.

---

permission?

optional permission?: Node

Defined in: tools/docs/src/info.ts:47

Permission node required to run it, if any.

---

usage

usage: string

Defined in: tools/docs/src/info.ts:44

Full usage as typed in game or console, e.g. /baddon reload.