UNPKG

2.35 kBTypeScriptView Raw
1import type { Destination } from './destination-service-types';
2import type { DestinationOptions } from './destination-accessor';
3/**
4 * Get all destinations from the environment variable "destinations".
5 * This is discouraged for productive use! Use [[useOrFetchDestination]] for fetching destinations from the Cloud Foundry destination service.
6 *
7 * @returns A list of destinations
8 */
9export declare function getDestinationsFromEnv(): Destination[];
10/**
11 * @deprecated Since v1.4.2. Use [[getDestinationsFromEnv]] instead.
12 *
13 * Get all destinations from the environment variable "destinations".
14 * This is discouraged for productive use! Use destination-accessor/useOrFetchDestination for fetching destinations
15 * from the Cloud Foundry destination service.
16 *
17 * @returns A list of destinations
18 */
19export declare function getDestinations(): Destination[];
20/**
21 * Get a destination from the environment variables by name. If there are multiple destinations with the same name the first one will be used.
22 * This is discouraged for productive use! Use destination-accessor/useOrFetchDestination for fetching destinations
23 * from the Cloud Foundry destination service.
24 * @param name - Name of the destination
25 * @returns The requested destination if existent, otherwise `null`
26 */
27export declare function getDestinationFromEnvByName(name: string): Destination | null;
28/**
29 * @deprecated Since v1.4.2. Use [[getDestinationFromEnvByName]] instead.
30 *
31 * Get a destination from the environment variables by name. Throws an error if there are multiple destinations with the same name.
32 * This is discouraged for productive use! Use destination-accessor/useOrFetchDestination for fetching destinations
33 * from the Cloud Foundry destination service.
34 * @param name - Name of the destination
35 * @returns The requested destination if existent, otherwise `null`
36 */
37export declare function getDestinationByName(name: string): Destination | null;
38/**
39 * @hidden
40 */
41export declare function getDestinationConfig(dest?: string | Destination): Destination | null;
42/**
43 * @hidden
44 */
45export declare function getDestinationsEnvVariable(): string | undefined;
46/**
47 * @hidden
48 */
49export declare function searchEnvVariablesForDestination(name: string, options?: DestinationOptions): Destination | undefined;
50//# sourceMappingURL=destination-from-env.d.ts.map
\No newline at end of file