Class: DownloadBackupCommand

Defined in: electron/services/commands/DatabaseCommands.ts:305

Command for downloading a database backup as a buffer and file name.

Remarks

Encapsulates the logic for downloading a backup and emitting a success event. Rollback and validation are no-ops.

Extends

• DatabaseCommand<{ buffer: Buffer; fileName: string; }>

Constructors

Constructor

new DownloadBackupCommand(serviceFactory: DatabaseServiceFactory, eventEmitter: TypedEventBus<UptimeEvents>, cache: StandardizedCache<Site>): DownloadBackupCommand

Defined in: electron/services/commands/DatabaseCommands.ts:152

Parameters

serviceFactory

DatabaseServiceFactory

eventEmitter

TypedEventBus<UptimeEvents>

cache

StandardizedCache<Site>

Returns

DownloadBackupCommand

Inherited from

DatabaseCommand.constructor

Properties

cache

protected readonly cache: StandardizedCache<Site>

Defined in: electron/services/commands/DatabaseCommands.ts:95

Site cache for data synchronization during operations

Inherited from

DatabaseCommand.cache

---

eventEmitter

protected readonly eventEmitter: TypedEventBus<UptimeEvents>

Defined in: electron/services/commands/DatabaseCommands.ts:98

Event bus for emitting command execution events

Inherited from

DatabaseCommand.eventEmitter

---

serviceFactory

protected readonly serviceFactory: DatabaseServiceFactory

Defined in: electron/services/commands/DatabaseCommands.ts:101

Factory for accessing database services and repositories

Inherited from

DatabaseCommand.serviceFactory

Methods

emitFailureEvent()

protected emitFailureEvent(eventType: keyof UptimeEvents, error: Error, data: Partial<UptimeEvents[keyof UptimeEvents]>): Promise<void>

Defined in: electron/services/commands/DatabaseCommands.ts:116

Internal

Emits a failure event for the command operation.

Parameters

eventType

keyof UptimeEvents

The event type to emit.

error

Error

The ://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error that occurred.

data

Partial<UptimeEvents[keyof UptimeEvents]> = {}

Additional event data to include in the event payload.

Returns

Promise<void>

Remarks

Used internally to emit a typed event indicating command failure, including error details and additional event data.

Inherited from

DatabaseCommand.emitFailureEvent

---

emitSuccessEvent()

protected emitSuccessEvent(eventType: keyof UptimeEvents, data: Partial<UptimeEvents[keyof UptimeEvents]>): Promise<void>

Defined in: electron/services/commands/DatabaseCommands.ts:141

Internal

Emits a success event for the command operation.

Parameters

eventType

keyof UptimeEvents

The event type to emit.

data

Partial<UptimeEvents[keyof UptimeEvents]>

Additional event data to include in the event payload.

Returns

Promise<void>

Remarks

Used internally to emit a typed event indicating command success, including additional event data.

Inherited from

DatabaseCommand.emitSuccessEvent

---

execute()

execute(): Promise<{ buffer: Buffer; fileName: string; }>

Defined in: electron/services/commands/DatabaseCommands.ts:311

Executes the command operation.

Returns

Promise<{ buffer: Buffer; fileName: string; }>

Promise resolving to the operation result.

Remarks

Performs the main database operation encapsulated by the command.

Throws

When command execution fails.

Overrides

DatabaseCommand.execute

---

rollback()

rollback(): Promise<void>

Defined in: electron/services/commands/DatabaseCommands.ts:339

No-op rollback for backup operations.

Returns

Promise<void>

Resolved promise since backup operations are read-only and do not require rollback.

Remarks

Backup operations are inherently safe and do not modify the database state, so no rollback action is necessary. Returns a resolved promise to satisfy the IDatabaseCommand interface contract.

Overrides

DatabaseCommand.rollback

---

validate()

validate(): Promise<{ errors: string[]; isValid: boolean; }>

Defined in: electron/services/commands/DatabaseCommands.ts:353

Validates backup operation prerequisites.

Returns

Promise<{ errors: string[]; isValid: boolean; }>

Resolved promise with validation result indicating success.

Remarks

Backup operations have minimal prerequisites, so validation always succeeds. Returns a resolved promise to satisfy the IDatabaseCommand interface contract.

Overrides

DatabaseCommand.validate

---

getDescription()

getDescription(): string

Defined in: electron/services/commands/DatabaseCommands.ts:364

Gets a description of the command for logging and debugging.

Returns

string

Human-readable command description.

Overrides

DatabaseCommand.getDescription