polen/build/lib/task/report.d.ts

A framework for delightful GraphQL developer portals

import type { Definition, MaskOptions } from './task.js';
export interface Report<$Input, $Output> {
    task: Definition<$Input, $Output>;
    execution: {
        input: $Input;
        output: $Output | Error;
        timings: {
            start: number;
            end: number;
            duration: number;
        };
    };
}
export interface FormatOptions<$Input, $Output> {
    /**
     * Force masks to reveal all data
     */
    debug?: boolean;
    /**
     * A mask to apply to the input (if any) and successful return (if any).
     *
     * @default Uses the mask bundled with the task, if any.
     */
    mask?: MaskOptions<$Input, $Output>;
}
export declare const formatReport: <$Input, $Output>(report: Report<$Input, $Output>, options?: FormatOptions<$Input, $Output>) => string;
export declare const exitWithReport: <$Input, $Output>(report: Report<$Input, $Output>, options?: FormatOptions<$Input, $Output>) => never;
//# sourceMappingURL=report.d.ts.map