@airplane/views/dist/state/tasks/useRunbookMutation.d.ts

A React library for building Airplane views. Views components are optimized in style and functionality to produce internal apps that are easy to build and maintain.

import { ParamValues, DefaultParams } from "../../client/executeTask";
import { ExecuteError, RefetchQuery, RunbookMutation } from "../../components/query";
export type RunbookMutationHookOptions<TParams extends ParamValues | undefined = DefaultParams> = {
    /**
     * The params of the runbook to execute.
     */
    params?: TParams;
    /**
     * If set, the provided tasks will be refetched on success.
     *
     * This can be useful if you expect the runbook mutation to invalidate data.
     */
    refetchTasks?: RefetchQuery | RefetchQuery[];
    /**
     * Callback on successful runbook execution.
     */
    onSuccess?: (sessionID: string) => void;
    /**
     * Callback on failed runbook execution.
     */
    onError?: (error: ExecuteError, sessionID?: string) => void;
};
export type RunbookMutationFn<TParams extends ParamValues | undefined = DefaultParams> = (options?: RunbookMutationHookOptions<TParams>) => void;
export type RunbookMutationState = {
    /**
     * Will be true when the runbook is currently executing.
     */
    loading?: boolean;
    /**
     * Will be set with the error message if the runbook failed to execute.
     */
    error?: ExecuteError;
    /**
     * The ID of the session.
     */
    sessionID?: string;
};
export type RunbookMutationResult<TParams extends ParamValues | undefined = DefaultParams> = {
    /**
     * Function that executes the runbook mutation.
     */
    mutate: RunbookMutationFn<TParams>;
} & RunbookMutationState;
export declare const useRunbookMutation: <TParams extends ParamValues | undefined = DefaultParams>(mutation: RunbookMutation<TParams>) => RunbookMutationResult<TParams>;