@kui-shell/core/mdist/core/jobs/watchable.d.ts

An Electron-based shell for cloud-native development

import { WatchableJob } from './job';
import { Entity } from '../../models/entity';
import { Row } from '../../webapp/models/table';
export interface Watcher {
    /**
     * the table renderer will call this function when the DOM
     * is ready to accept updates. when you have updates, please call
     * one or the other of the provided functions
     */
    init: (pusher: WatchPusher) => void;
}
export interface Watchable {
    watch: Watcher & WatchableJob;
}
/** callbacks to indicate state changes */
export interface WatchPusher {
    /**
     *
     * @param response Updated row model
     *
     * @param batch? is this part of a batch update? Updates to the view
     * will be deferred until a call to batchUpdateDone()
     *
     * @param changed? allows push provider to specify whether this
     * update should be visualized as a change to the model [default:
     * true]
     */
    update: (response: Row, batch?: boolean, changed?: boolean, idxToUpdate?: number) => void;
    /**
     * Update progress bar for a given row
     *
     * @param rowIdx row index (assumes no sorting, for now)
     * @param percentComplete how far along is the processing of this row?
     * @param [message] any transient message that might help understand the progress
     * @param [totalSize] if the row represents a sized of object, how big is it?
     * @param [fileName] if the row represents a named object, what is it called?
     *
     */
    progress: (progress: {
        rowIdx: number;
        percentComplete: number;
        message?: string;
        totalSize?: number;
        fileName?: string;
    }) => void;
    /** set table body */
    setBody: (response: Row[]) => void;
    /** A batch of calls to `update` is complete */
    batchUpdateDone: () => void;
    /** The given keyed row is gone */
    offline: (rowKey: string) => void;
    /** No more updates will be performed */
    done: () => void;
    /** The entire underlying model has disappared */
    allOffline: () => void;
    /** The header model has changed */
    header: (response: Row) => void;
    footer: (streams: string[]) => void;
}
export declare function isWatchable(model: Entity & Partial<Watchable>): model is Entity & Watchable;