UNPKG

2.11 kBTypeScriptView Raw
1import { HandlerContext } from "../../HandlerContext";
2import { EditorOrReviewerParameters } from "../common/params/BaseEditorOrReviewerParameters";
3import { ProjectOperationCredentials } from "../common/ProjectOperationCredentials";
4import { RepoFilter } from "../common/repoFilter";
5import { RepoFinder } from "../common/repoFinder";
6import { RepoRef } from "../common/RepoId";
7import { RepoLoader } from "../common/repoLoader";
8import { EditMode, EditModeFactory } from "./editModes";
9import { AnyProjectEditor, EditResult } from "./projectEditor";
10/**
11 * Edit all the given repos with the given editor
12 * @param {HandlerContext} ctx
13 * @param credentials credentials
14 * @param {ProjectEditor} editor
15 * @param editInfo: EditMode determines how the edits should be applied.
16 * Factory allows us to use different branches if necessary
17 * @param parameters parameters (optional)
18 * @param {RepoFinder} repoFinder
19 * @param {} repoFilter
20 * @param {RepoLoader} repoLoader
21 * @return {Promise<Array<EditResult>>}
22 */
23export declare function editAll<R, P extends EditorOrReviewerParameters>(ctx: HandlerContext, credentials: ProjectOperationCredentials, editor: AnyProjectEditor, editInfo: EditMode | EditModeFactory, parameters: P, repoFinder: RepoFinder, repoFilter?: RepoFilter, repoLoader?: RepoLoader): Promise<EditResult[]>;
24/**
25 * Edit the given repo with the given editor function, which depends only on the project
26 * @param {HandlerContext} ctx
27 * @param credentials credentials
28 * @param {ProjectEditor} editor
29 * @param editInfo: EditMode determines how the edits should be applied.
30 * @param singleRepository reference to the single repo to edit
31 * @param parameters parameters (optional)
32 * @param {RepoLoader} repoLoader (optional, useful in testing)
33 * @return {Promise<EditResult>}
34 */
35export declare function editOne<P extends EditorOrReviewerParameters>(ctx: HandlerContext, credentials: ProjectOperationCredentials, editor: AnyProjectEditor, editInfo: EditMode, singleRepository: RepoRef, parameters?: P, repoLoader?: RepoLoader): Promise<EditResult>;
36//# sourceMappingURL=editAll.d.ts.map
\No newline at end of file