mirror of
https://github.com/musix-org/musix-oss
synced 2024-11-14 03:30:18 +00:00
37 lines
1.8 KiB
TypeScript
37 lines
1.8 KiB
TypeScript
/**
|
|
* Copyright 2020 Google LLC
|
|
*
|
|
* 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.
|
|
*/
|
|
import { APICallback, CancellableStream, GRPCCall, ResultTuple, SimpleCallbackFunction } from './apitypes';
|
|
import { CancellablePromise, OngoingCall, OngoingCallPromise } from './call';
|
|
import { Descriptor } from './descriptor';
|
|
import { CallSettings } from './gax';
|
|
import { GoogleError } from './googleError';
|
|
import { StreamProxy } from './streamingCalls/streaming';
|
|
export interface ApiCallerSettings {
|
|
promise: PromiseConstructor;
|
|
}
|
|
/**
|
|
* An interface for all kinds of API callers (normal, that just calls API, and
|
|
* all special ones: long-running, paginated, bundled, streaming).
|
|
*/
|
|
export interface APICaller {
|
|
init(settings: ApiCallerSettings, callback?: APICallback): OngoingCallPromise | OngoingCall | StreamProxy;
|
|
wrap(func: GRPCCall): GRPCCall;
|
|
call(apiCall: SimpleCallbackFunction, argument: {}, settings: {}, canceller: OngoingCallPromise | OngoingCall | StreamProxy): void;
|
|
fail(canceller: OngoingCallPromise | OngoingCall | CancellableStream, err: GoogleError): void;
|
|
result(canceller: OngoingCallPromise | OngoingCall | CancellableStream): CancellablePromise<ResultTuple> | CancellableStream;
|
|
}
|
|
export declare function createAPICaller(settings: CallSettings, descriptor: Descriptor | undefined): APICaller;
|