src/app/core/ui/sync-status/background-process-state.interface.ts
Describe a task running in the background, such as index creation.
Properties |
|
| description |
description:
|
Type : string
|
| Optional |
|
additional optional details explaining the process |
| details |
details:
|
Type : string
|
| Optional |
|
specific details or context of the process. this can serve as a "subtitle" for a common title of several similar processes also |
| error |
error:
|
Type : any
|
| Optional |
|
if the process has failed, contains the error details; otherwise undefined |
| pending |
pending:
|
Type : boolean
|
|
whether the process is still running |
| title |
title:
|
Type : string
|
|
unique name of the process as displayed to user |
export interface BackgroundProcessState {
/** unique name of the process as displayed to user */
title: string;
/**
* specific details or context of the process.
* this can serve as a "subtitle" for a common title of several similar processes also
*/
details?: string;
/** additional optional details explaining the process */
description?: string;
/** whether the process is still running */
pending: boolean;
/** if the process has failed, contains the error details; otherwise undefined */
error?: any;
}