discovery.d.ts
1.26 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
import { GlobalOptions } from './api';
import { Endpoint } from './endpoint';
export declare type EndpointCreator = (options: GlobalOptions, google: {}) => Endpoint;
export interface DiscoveryOptions {
includePrivate?: boolean;
debug?: boolean;
}
export declare class Discovery {
private transporter;
private options;
/**
* Discovery for discovering API endpoints
*
* @param options Options for discovery
*/
constructor(options: DiscoveryOptions);
/**
* Generate and Endpoint from an endpoint schema object.
*
* @param schema The schema from which to generate the Endpoint.
* @return A function that creates an endpoint.
*/
private makeEndpoint;
/**
* Log output of generator. Works just like console.log
*/
private log;
/**
* Generate all APIs and return as in-memory object.
* @param discoveryUrl
*/
discoverAllAPIs(discoveryUrl: string): Promise<{}>;
/**
* Generate API file given discovery URL
*
* @param apiDiscoveryUrl URL or filename of discovery doc for API
* @returns A promise that resolves with a function that creates the endpoint
*/
discoverAPI(apiDiscoveryUrl: string | {
url: string;
}): Promise<EndpointCreator>;
}