Documentation

Documentation / @zerotal/queue / commands / QueueFailedCommand

Class: QueueFailedCommand

Defined in: queue/src/commands/QueueFailedCommand.ts:6

Base class for console commands; subclasses declare their name/args/flags via static properties and implement run().

A command's identity and CLI surface are described with the static fields (commandName, description, args, flags, and needsApp); the work happens in run(), where parsed this.args and this.flags are available along with output helpers (info, error, line, table, …) and interactive prompts (ask, confirm, choice, secret). Register the class with CommandRunner.register to expose it as bun zt <commandName>.

Example

import { Command } from "@zerotal/core";
import type { ArgDef, FlagDef } from "@zerotal/core";

export class GreetCommand extends Command {
  static commandName = "greet";
  static description = "Print a greeting";
  static needsApp = false;
  static args: ArgDef[] = [{ name: "name", required: true }];
  static flags: FlagDef[] = [
    { name: "loud", short: "l", type: "boolean", default: false },
  ];

  async run(): Promise<void> {
    const greeting = `Hello, ${this.args["name"]}!`;
    this.info(this.flags["loud"] ? greeting.toUpperCase() : greeting);
  }
}

Invoke it once registered:

bun zt greet Ada --loud

Extends

• Command

Constructors

Constructor

new QueueFailedCommand(): QueueFailedCommand

Returns

QueueFailedCommand

Inherited from

Command.constructor

Properties

args

static args: ArgDef[] = []

Defined in: core/src/command/Command.ts:67

Inherited from

Command.args

_writer

_writer: OutputWriter

Defined in: core/src/command/Command.ts:71

Output destination. Replaced with BufferWriter by Artisan.call().

Inherited from

Command._writer

args

args: Record<string, string> = {}

Defined in: core/src/command/Command.ts:74

Parsed positional arguments — set by CommandRunner before run().

Inherited from

Command.args

flags

flags: Record<string, string | boolean | number> = {}

Defined in: core/src/command/Command.ts:76

Parsed flags — set by CommandRunner before run().

Inherited from

Command.flags

app

app: unknown = undefined

Defined in: core/src/command/Command.ts:78

Application instance — set by CommandRunner when needsApp is true.

Inherited from

Command.app

commandName

static commandName: string = "queue:failed"

Defined in: queue/src/commands/QueueFailedCommand.ts:7

Overrides

Command.commandName

description

static description: string = "List all failed jobs"

Defined in: queue/src/commands/QueueFailedCommand.ts:8

Overrides

Command.description

needsApp

static needsApp: boolean = true

Defined in: queue/src/commands/QueueFailedCommand.ts:9

Overrides

Command.needsApp

flags

static flags: object[]

Defined in: queue/src/commands/QueueFailedCommand.ts:11

name

name: string = "queue"

short

short: string = "q"

type

type: "string"

description

description: string = "Filter by queue name"

default

default: string = ""

Overrides

Command.flags

Methods

info()

info(msg): void

Defined in: core/src/command/Command.ts:82

Parameters

msg

string

Returns

void

Inherited from

Command.info

error()

error(msg): void

Defined in: core/src/command/Command.ts:85

Parameters

msg

string

Returns

void

Inherited from

Command.error

warn()

warn(msg): void

Defined in: core/src/command/Command.ts:88

Parameters

msg

string

Returns

void

Inherited from

Command.warn

line()

line(msg): void

Defined in: core/src/command/Command.ts:91

Parameters

msg

string

Returns

void

Inherited from

Command.line

dim()

dim(msg): void

Defined in: core/src/command/Command.ts:94

Parameters

msg

string

Returns

void

Inherited from

Command.dim

write()

write(msg): void

Defined in: core/src/command/Command.ts:97

Parameters

msg

string

Returns

void

Inherited from

Command.write

newLine()

newLine(): void

Defined in: core/src/command/Command.ts:100

Returns

void

Inherited from

Command.newLine

section()

section(title): void

Defined in: core/src/command/Command.ts:103

Parameters

title

string

Returns

void

Inherited from

Command.section

table()

table(rows, indent?): void

Defined in: core/src/command/Command.ts:106

Parameters

rows

[string, string][]

indent?

number = 2

Returns

void

Inherited from

Command.table

ask()

ask(question, defaultValue?): Promise<string>

Defined in: core/src/command/Command.ts:127

Prompt the user for text input and wait for Enter.

Parameters

question

string

defaultValue?

string

Returns

Promise<string>

Example

const name = await this.ask('What is your name?');
const env  = await this.ask('Environment?', 'production');

Inherited from

Command.ask

confirm()

confirm(question, defaultValue?): Promise<boolean>

Defined in: core/src/command/Command.ts:142

Prompt the user for a yes/no confirmation. Returns true for y/yes, false otherwise.

Parameters

question

string

defaultValue?

boolean = false

Returns

Promise<boolean>

Example

const ok = await this.confirm('Run migrations?');
const ok = await this.confirm('Overwrite file?', true);

Inherited from

Command.confirm

choice()

choice(question, options): Promise<string>

Defined in: core/src/command/Command.ts:157

Prompt the user to select one option from a numbered list. Returns the selected string. Defaults to the first option on invalid input.

Parameters

question

string

options

string[]

Returns

Promise<string>

Example

const env = await this.choice('Environment:', ['local', 'staging', 'production']);

Inherited from

Command.choice

secret()

secret(question): Promise<string>

Defined in: core/src/command/Command.ts:170

Parameters

question

string

Returns

Promise<string>

Inherited from

Command.secret

_readLine()

_readLine(): Promise<string>

Defined in: core/src/command/Command.ts:213

Read one line from stdin. Override in tests to avoid blocking.

Returns

Promise<string>

Inherited from

Command._readLine

run()

run(): Promise<void>

Defined in: queue/src/commands/QueueFailedCommand.ts:21

Returns

Promise<void>

Overrides

Command.run