polygerrit-ui/app/api/repo.ts

/**
 * @license
 * Copyright (C) 2020 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
export type RepoCommandCallback = (
  repo?: string,
  /**
   * This is a ConfigInfo object as defined here:
   * https://gerrit-review.googlesource.com/Documentation/rest-api-projects.html#config-info
   * We neither want to repeat it nor add a dependency on it here.
   */
  config?: unknown
) => boolean;

export interface RepoPluginApi {
  createCommand(title: string, callback: RepoCommandCallback): RepoPluginApi;

  onTap(callback: (event: Event) => boolean): RepoPluginApi;
}