blob: 2b91bf6a43b236795ca7911921ed579cea6b4b1c [file] [log] [blame]
/**
* @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 RequestPayload = string | object;
export enum HttpMethod {
HEAD = 'HEAD',
POST = 'POST',
GET = 'GET',
DELETE = 'DELETE',
PUT = 'PUT',
}
export type ErrorCallback = (response?: Response | null, err?: Error) => void;
export declare interface RestPluginApi {
getLoggedIn(): Promise<boolean>;
getVersion(): Promise<string | undefined>;
/**
* Returns a ServerInfo object as defined here:
* https://gerrit-review.googlesource.com/Documentation/rest-api-config.html#server-info
* We neither want to repeat it nor add a dependency on it here.
*/
getConfig(): Promise<unknown>;
invalidateReposCache(): void;
fetch(
method: HttpMethod,
url: string,
payload?: RequestPayload,
errFn?: undefined,
contentType?: string
): Promise<Response>;
fetch(
method: HttpMethod,
url: string,
payload: RequestPayload | undefined,
errFn: ErrorCallback,
contentType?: string
): Promise<Response | void>;
fetch(
method: HttpMethod,
url: string,
payload: RequestPayload | undefined,
errFn?: ErrorCallback,
contentType?: string
): Promise<Response | void>;
/**
* Fetch and return native browser REST API Response.
*/
fetch(
method: HttpMethod,
url: string,
payload?: RequestPayload,
errFn?: ErrorCallback,
contentType?: string
): Promise<Response | void>;
/**
* Fetch and parse REST API response, if request succeeds.
*/
send(
method: HttpMethod,
url: string,
payload?: RequestPayload,
errFn?: ErrorCallback,
contentType?: string
): Promise<unknown>;
get(url: string): Promise<unknown>;
post(
url: string,
payload?: RequestPayload,
errFn?: ErrorCallback,
contentType?: string
): Promise<unknown>;
put(
url: string,
payload?: RequestPayload,
errFn?: ErrorCallback,
contentType?: string
): Promise<unknown>;
delete(url: string): Promise<Response>;
}