@atomist/sdm/lib/spi/project/ProjectLoader.d.ts

Atomist Software Delivery Machine SDK

import { HandlerContext } from "@atomist/automation-client/lib/HandlerContext";
import { ProjectOperationCredentials } from "@atomist/automation-client/lib/operations/common/ProjectOperationCredentials";
import { RemoteRepoRef } from "@atomist/automation-client/lib/operations/common/RepoId";
import { GitProject } from "@atomist/automation-client/lib/project/git/GitProject";
import { CloneOptions } from "@atomist/automation-client/lib/spi/clone/DirectoryManager";
/**
 * Operation on loaded project
 */
export declare type WithLoadedProject<T = any> = (p: GitProject) => Promise<T>;
export interface ProjectLoadingParameters {
    credentials: ProjectOperationCredentials;
    id: RemoteRepoRef;
    cloneOptions?: CloneOptions;
    context?: HandlerContext;
    /** Return true to get optimized behavior for read only */
    readOnly: boolean;
    /**
     * Explicitly configured target clone dir
     */
    cloneDir?: string;
}
/**
 * Common interface for project loading that allows caching etc.
 */
export interface ProjectLoader {
    /**
     * Perform an action with the given project
     * @param {ProjectLoadingParameters} params
     * @param {WithLoadedProject<T>} action
     */
    doWithProject<T>(params: ProjectLoadingParameters, action: WithLoadedProject<T>): Promise<T>;
}
//# sourceMappingURL=ProjectLoader.d.ts.map