Yurba.js / @yurbajs/types / CommandArgsSchemaEntry

Type Alias: CommandArgsSchemaEntry

CommandArgsSchemaEntry = object

Represents a single argument schema entry for a command.

Examples

// A required string argument
{ type: 'string', required: true }

// An optional integer argument with a default value
{ type: 'int', default: 0 }

// A rest argument that captures all remaining input
{ type: 'string', rest: true }

Properties

default?

optional default: any

---

required?

optional required: boolean

---

rest?

optional rest: boolean

---

type

type: "string" | "int"