Skip to main content

Variable: ScanStatus

@arolariu/website

@arolariu/website / types/scans/Scan / ScanStatus

Variable: ScanStatus

const ScanStatus: object

Defined in: types/scans/Scan.ts:97

Represents the lifecycle status of a standalone scan.

Type Declaration​

UPLOADING​

readonly UPLOADING: "uploading" = "uploading"

Upload in progress

READY​

readonly READY: "ready" = "ready"

Uploaded to Azure, available for use

ATTACHED​

readonly ATTACHED: "attached" = "attached"

Associated with an invoice entity

DETACHED​

readonly DETACHED: "detached" = "detached"

Previously attached, now dissociated

FAILED​

readonly FAILED: "failed" = "failed"

Upload failed

PROCESSING​

readonly PROCESSING: "processing" = "processing"

Being used to create an invoice

ARCHIVED​

readonly ARCHIVED: "archived" = "archived"

Invoice created, scan archived

Remarks​

Tracks the scan through its lifecycle from upload to invoice creation.

State Transitions:

UPLOADING → READY → ATTACHED → DETACHED → ARCHIVED
    ↓
  FAILED

UI Implications:

  • UPLOADING: Show progress indicator
  • READY: Available for selection and invoice creation
  • ATTACHED: Associated with an invoice entity
  • DETACHED: Previously attached, now dissociated
  • PROCESSING: Being used to create an invoice (show spinner)
  • ARCHIVED: Invoice created, scan no longer shown in active view
  • FAILED: Show error state with retry option

Example​

if (scan.status === ScanStatus.READY) {
  // Show scan in selection view
}
// was this page useful?